Pipeline Instructions

Write pre and post deployment instructions for pipelines. Users must acknowledge them before execution proceeds.

circle-info

Instructions are created first, then linked to pipelines via a User Actions step. The pipeline pauses at this step until acknowledged.

chevron-rightCreate Pipeline Instructionshashtag
  1. Login → click Pipelines → click the Instruction tab.

  2. Click + New Pipeline Instructions.

  3. Fill in: Name, Type, Instructions, Description, Owner, Jira, Point of Contact, Environments, Release, RBAC, and Tags.

  4. Click Create.

Supported Actions on Instructions

  • 📋 View Usage: The Usage tab lists all pipelines associated with this instruction.

  • ✏️ Edit Settings: The Settings tab lets you edit instruction fields and save changes.

  • 🔍 Filter: Filter instructions by Type, Tag, Owner, and Status.

chevron-rightConfigure User Action Pipeline Stephashtag
  1. Open the target pipeline → click the newly created step.

  2. Under Step Setup: enter a name (e.g., "Pipeline Instructions"), select tool as User Actions → click Save, then Close.

  3. Under Step Settings: select Pipeline Instructions from the dropdown.

  4. Optionally enable Custom Notification Message and enter your message.

  5. Click Create to finalize.

⚠️ When triggered, the pipeline pauses at this step withPendingstatus until acknowledged.

chevron-rightAcknowledge Pipeline Instructionshashtag
  1. Open the pipeline → click Acknowledge Action.

  2. Provide Instruction Comments.

  3. Click Acknowledge Pipeline Instructions to approve, or Refuse Pipeline Instructions to reject.

chevron-rightView Logs and Audit Trailhashtag

Pipeline Activity Logs

  1. Go to the Summary tab of the pipeline.

  2. Under Pipeline Logs, click the User Actions Instructions step to view details.

Instruction Audit Logs

  1. Open the Pipeline Instruction → click the Audit log icon (top right).

  2. Filter by: Date Range, Site Roles, User, or Action Type.

Last updated