Helix Swarm User Workflow Guide

This guide tells you how to use the Swarm workflow feature and includes a step-by-step walk-through of an example workflow. The guide takes you through the steps involved in setting up a workflow, adding your workflow to a project/branch, and using the workflow to progress through a code review. This guide is intended for all Swarm users.

New for Swarm 2021.2

For a complete list of what's new in Swarm for this release, see What's new in the Helix Swarm Guide.

Improvements to automatic tests

  • Iterate tests for affected projects and branches

  • Swarm now supports separate test runs for each project and branch when the review spans a number projects and branches. This is selected on a per test basis, see Iterate tests for affected projects and branches in the Helix Swarm Guide.

  • Add On Demand tests to workflows

  • You can now add tests to a workflow and set them to be run manually from reviews that use that workflow.

    • For information on adding an on demand test to a workflow, see Add a workflow.

    • For information on manually running a test, see Test status.

  • Rerun tests from the review

  • You can now rerun tests from the Test status dropdown in a review, see Test status.

  • Block approval if a test fails

  • You can now block approval of a review if a test fails, see Add a workflow.

Work-in-Progress tag for shelved changelists

You can now add a work-in-progress tag (#wip by default) to a pending changelist description so that you can update the files in your shelf without triggering an update to the associated review or the creation of a new review. This is useful when a lot of changes are requested for a review, and you want to do them in stages and get them all reviewed when you are happy with your changes. When you are ready for your changes to go back into review, delete #wip from the changelist description and update your shelf to update the review.

Additional help for Helix Core

Command line client usage

See the Helix Core Server User Guide for information on how to use the Helix server Command Line Client.

Command reference

See p4 client (graph) in the Helix Core P4 Command Reference for help configuring Helix server for building from mixed clients.

Helix server administration

See Helix Core Server Administrator Guide for information on installation, configuration, and management of Helix server.