Skip to main content

Require approval before a step moves on

Any step of a project's pipeline can wait for people to approve it before it runs. A release into Production that needs two approvals, for example, waits until two approvers have selected Approve. You set the count, who may approve, and what happens when nobody answers.

Who can do this: anyone who may edit the project. Others see the settings but can't change them.

Plan: approvals are set in a project's custom pipeline, under Settings › CI Pipeline, which shows only where the organization's plan includes Custom pipelines.

Set the approvals​

  1. In the sidebar, select Directory, then the Projects tab, and select the project's name.
  2. In Settings, select CI Pipeline. Under Steps, select the step that should wait, such as Release from Dev to Production. Its settings open.
  3. Under Approvals, pick a number from 1 to 5 in Needed. The rest of the group appears.
  4. Under Approvers, Same as who can press is ticked: anyone who may press the step may approve it. To name other approvers, untick it, then select the picker below to tick roles (Org Owner, Org Admin, Maintainer, Developer) and add members.
  5. Leave Requester can't approve ticked so that whoever asked for the step can't approve it. Untick it to let their approval count.
  6. Optional: set an Approval timeout with its unit (minutes, hours or days, from 15 minutes to 30 days). Then pick On timeout: Cancel ends the request, Keep waiting reminds the approvers.
  7. Optional: write Instructions for approvers, up to 1,000 characters, such as what to check first. Approvers see them beside Approve.
  8. Select Save at the foot of the tab.

The step's summary under Steps now names the count, such as By hand · 2 approvals.

Save refuses a count the approvers can't reach, such as 2 approvals with one named person and no role, and says so under Approvers. Your organization may also require approvals on the step into production; see Set your org's pipeline rules.

What approvers see​

On the Tasks page, a step waiting for approvals shows a chip such as 0/2 approvals. Hover or tap it to see who may approve, who already did, and the instructions. Each person who may approve sees Approve. More on the chip is in Release to production.

To stop requiring approval, set Needed back to 0 and select Save.