Skip to main content

Release with a change ticket

Some teams release only against an approved change ticket. A project's pipeline can ask whoever presses a Release step for one: a Jira issue, or a ServiceNow change request. The release then runs only once the ticket is in the state the step expects. This guide is for the person releasing. To set the step up, see Add a gate to a pipeline step.

Who can do this: anyone who may release to that stage. That is edit access to the project, unless its pipeline names who may release.

  1. Select Tasks in the sidebar, then the project in the Projects tree.

  2. Select the Pipeline tab, then the Release step between the two stages, such as Dev and Production. The row above the list shows what will ship.

  3. Find the field just before Release: Ticket for Jira, Change ticket for ServiceNow. Its placeholder shows the shape it takes, such as OPS-123 or CHG0031042.

    The release row of the Pipeline view: Dev → Production, 17/17 shipping, cost, tokens and age, then Now, Release 17 and Connect deploys. This step asks for no ticket, so the field is not shown

  4. Type the ticket's key. Jaah looks it up as you stop typing, and a chip beside the field says what it found:

    • the ticket's status as your tracker names it, or Found, in green: Jaah found it. Hover it for the key and status.
    • No ticket and the key, such as No ticket OPS-124, in red: your tracker doesn't know it. Check the key; Release stays greyed out.
    • Not checked, in amber: Jaah couldn't look it up, for example when you can't use the step's tracker login. Hover it for why. You can still release, and the step checks the ticket when the release runs.
  5. Leave When at Now, or select the clock to pick a time.

  6. Select Release N. The release keeps the ticket you typed, and the step checks the ticket's state before it merges. If the ticket is not in the expected state, the release fails at that check.

The field shows only on a hand-pressed release. A step that runs by itself takes a fixed ticket or query instead, set on the step.

The capture shows a step without a ticket check: the organization it was taken in has none, so the Ticket field and its chips could not be photographed.