Publish a workflow version

Publish a workflow version to make it the active version for all triggers, scheduled runs, and manual runs. When you publish, automation orchestrator activates all webhook and scheduled triggers defined in the workflow.

Before you begin

  • A workflow with at least one saved version.
  • You have permission to manage workflows in the project.

Procedure

  1. Open the workflow in the workflow builder.
  2. Verify that the current version contains the changes you want to publish.

    If you have unsaved changes, click Save to create a new version before publishing.

  3. Click Publish workflow in the toolbar.
    Note:

    Automation orchestrator validates the workflow before publishing. If the workflow has errors or warnings, the Publish workflow button is unavailable. Resolve all validation findings before publishing. See Check your workflow for errors before publishing.

  4. Enter a Version name to give this published version a display label, for example v1.0 - production release.

    The field is pre-populated with a formatted timestamp.

  5. Optional: Enter a Change description to record why you are publishing this version.
  6. Confirm the publish action.
  7. To publish by using the API, send a POST request to the publish endpoint: 
    $ curl -X POST \
    "${AO_URL}/api/v1/workflows/${WORKFLOW_ID}/versions/${VERSION}/publish" \
    -H "Authorization: Bearer ${TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "v1.0 - production release",
      "change_description": "Initial production deployment"
    }'

    Replace ${WORKFLOW_ID} with the workflow identifier, and ${VERSION} with the version number to publish. The name and change_description fields are optional.

Results

  • The workflow status changes from Draft to Published in the workflow list.
  • Any webhook triggers defined in the workflow begin accepting requests.
  • Any scheduled triggers begin running using the published version.
  • If a previous version was published, its status changes to Previously published.

If scheduled triggers cannot be activated, the workflow is still published but a warning banner appears. Republish the workflow to retry activating scheduled triggers. Webhook triggers and manual runs are not affected.