Upsource 2017.2 Help

Custom workflows

Some actions around commits and reviews are quite common and can be automated by including them in a custom workflow.

You can set up a workflow to automatically:

  • Create reviews (and assign reviewers) for commits that match specified criteria, for example when someone changes certain parts of the codebase, or if the commit message has an issue ID specified. This can be especially useful if you have a so-called “critical path”, a part of your system where you want to be 100% certain no change goes unnoticed by you, or a dedicated members of your team.

  • Add revisions to reviews, when revisions match specified criteria, e.g. when authored by certain committer(s), or a review ID or issue ID is mentioned in the commit message.

  • Assign participants (reviewers and watchers) to reviews created either manually or automatically.

  • Close a review when all participating reviewers accept the changes.

  • Resolve all discussions in a review when it gets closed.

Workflows are configured on the per-project basis.

To set up a custom workflow:

  1. Click the settings icon Settings on the top right of the screen. The Administration view will open.
  2. Locate the project you want to set up a workflow for and click Edit project next to its name. In the right pane, under Settings, click Custom workflows. You'll be redirected to the Custom workflows form.

    workflows.png

To automatically create reviews:

  1. Check the corresponding checkbox and click Add trigger
  2. Specify the trigger criteria
  3. Specify one or more reviewers

    workflow1

To automatically add revisions to a review:

  1. Check the corresponding checkbox and click Add trigger
  2. Specify the trigger criteria: review ID, issue ID
  3. Choose one or more commit authors (if part of the criteria)

    workflow2

To automatically assign participants (reviewers or watchers) to a review:

  1. Check the corresponding checkbox and click Add trigger
  2. Specify the review trigger criteria: the review type and who it was created by.
  3. Specify and add one or more participants to be assigned to the review that matches the specified criteria.

    workflow3.png

The Close reviews and Resolve discussions triggers are set similarly to the ones described above.

When you are done, click Save changes. Your workflow is now in effect.

Last modified: 10 September 2017

See Also