Skip to main content

Workflow versions and deployments

In briefEvery committed change to a workflow is a new, numbered version kept in its history. A deployment decides which version runs in which environment, either the latest or a pinned one, for an optional date window, and can rewrite references with transform rules as the workflow is served there.

WhereDesign › Workflows › open a workflow. The filled save action in the editor toolbar commits a version (Commit changes to a version), and the version selector shows which version you are looking at and whether it is committed. Manage Deployment in the same toolbar opens the Deploy modal, with one card per environment: Set-up Deployment on a card creates a deployment, Edit and Delete change or remove it, and Replace schedules a replacement from a future date. A deployment's transform rules are edited in its New Deploy or Edit Deploy form. Deployment history and rollback are available through the API only.

WhenUse this page when:

  • a change you made is not showing up in an environment;
  • you want one environment on a tested version while another follows the latest;
  • you want an environment to change version or rules from a set day, with no gap;
  • you need the same design to run against a different environment's agents, properties or frequencies;
  • a commit, deployment or deletion is refused because of a sub-workflow.

To start a separate workflow from an existing one, use Copy a workflow; to move configuration between environments, use Automation export and import.

How

  1. Commit your changes in the workflow editor. From the second version on, the Save to a New Version dialog offers an optional Notes field for the version history.
  2. Select Manage Deployment, and use Set-up Deployment on the environment's card.
  3. In Version, choose Latest, or a version to pin the deployment to, and set the Effective Date and Expiration Date if the deployment should have a window.
  4. Add transform rules for anything that differs in that environment, and select Deploy.

The full steps are on Version and deploy a workflow.

Notes
  • Drafts stay in your browser until you commit. A Latest deployment serves the newest committed version; a Pinned one keeps serving its version.
  • A draft that a newer version has overtaken is flagged by a banner above the canvas, and its commit is refused. Discard changes loads the latest version and deletes your edits, so copy them from Code View first.
  • The Deploy modal shows only the environments in which you may view this workflow's deployments.
  • A rollback restores a deployment's settings, not its transform rules.
  • A replacement scheduled with Replace takes over on its Effective Date; until then the current deployment keeps building, and its Expiration Date follows the replacement's start.
  • Some fields can never be changed by a transform rule; a rule that targets one, or renames a field on the way to one, is refused when you save it.
  • An agent rename sends the job to the target agent, even when a different relay serves it.
  • A sub-workflow must be deployed wherever, and for whenever, its parent is.
  • Rename in the Workflow Settings panel renames a saved workflow without creating a version.
Watch out
  • Committing changes what every Latest environment builds next, so check them before you commit.
  • Delete is disabled on a sub-workflow's deployment while a deployed parent still uses it.
  • Moving a live deployment's Effective Date into the future stops it building until then. Use Replace to keep it running until the change.
  • Environment-level rules apply to every deployment in that environment and are not counted on a deployment's card.
  • In an Advanced rule's filter, quote a value with ( or ) at either end in double quotes, not single: a single-quoted one is refused when you save, unless it ends in ) and closes the filter.
  • A rule path that is valid but finds nothing in the deployed configuration still saves, and does nothing.
  • An Advanced rule's filter may only read values, and its Source Pattern must be one that runs quickly: a filter that does more, or a pattern such as (a+)+, is refused when you save.