Helix Swarm User Workflow Guide (2019.2)

Create a workflow

In this section we will create the example workflow described in Workflow: a step-by-step walk-through.

Note
  • Swarm workflows can be created by any Swarm user.
  • Shared Swarm workflows can be viewed by any Swarm user.
  • Shared Swarm workflows can be applied to a project or project branch by any Swarm user that is authorized to edit the project.

Add the example workflow:

  1. On the Swarm Workflows page, click the + Add Workflow button.
  2. Enter a name for the workflow:
  3. Optional: provide a description for the workflow.
  4. Image of an example workflow settings page
  5. Rules: Set the workflow rules as follows:

    • On commit without a review set to: Reject.
    • On commit with a review set to: Reject unless approved.
    • On update of a review in an end state set to: Reject.
    • Tip

      The protected end states are globally set by your Swarm administrator, the default protected end states are Archived, Rejected, and Approve:Commit.

    • Count votes up from set to: Members.
    • Automatically approve reviews set to: Based on vote count

      Tip

      The Minimum up vote value is set on the project/branch the workflow is associated with.

  6. You are automatically added as the owner of the workflow.

    Optional: add more owners if required. This field auto-suggests groups, and users within Helix server as you type (up to a combined limit of 20 entries).

    Important
    • A workflow must have at least one owner.
    • If you remove yourself as an owner, you cannot edit this workflow configuration later unless you have super user rights.
  7. Optional: if you want other Swarm users to be able to use this workflow, select the Shared with others checkbox.

    Tip

    Leave the checkbox unselected until you have proved that the workflow rules work as expected. This keeps the workflow private and stops other Swarm users using the workflow until you are happy with it. Once you are happy with the workflow, select the checkbox to share the workflow with other users.

  8. Click Save.

    Note

    The Save button is disabled if any required fields are empty.

  9. Now that you have created a workflow associate the workflow with a project, see Add a workflow to a project/branch.