Approval workflows

Increase the quality of your tracking plan with protected main branch and branch approvals

2 minute read

Building a tracking plan is a team sport. Getting feedback from your team on the changes you're making to the tracking plan helps with building alignment and keeping the plan consistent. That's why we built approval workflows. Approval workflows can be configured in three ways:

  1. Protected main branch
  2. Require admin approval
  3. Require multiple approvals

Protected main branch

To make sure no one accidentally makes changes directly on the main branch and to encourage peer reviews of branches, you can opt in to protecting the main branch. That means:

  • Only admins can make changes directly on the main branch
  • Only admins can merge branches that haven't been approved by a branch collaborator (editor or admin)

Enabling protected main branch is a prerequisite for using require admin approval and require multiple approvals.

To enable this configuration, click the settings wheel in your workspace, in Workspace settings go into the Permissions tab and check "Protected main branch".

Protecting the main branch

Require admin approval

To make sure all tracking plan changes are reviewed by a dedicated group of people, you can opt in to require admin approval. That means that branch cannot be merged into the main branch unless at least one admin has approved the changes.

To enable this configuration, click the settings wheel in your workspace, in Workspace settings go into the Permissions tab and check "Require admin approval". Note that "Protected main branch" must be enabled to enable "Require admin approval".

Required admin approval

Require multiple approvals

You can configure how many approvals are required to merge a branch. By default, only one approval is required, but you can require up to three approvals before a branch can be merged. When the branch status is changed to Draft or Request Changes, all previous approvals are removed and the approval counter resets.

To change the number of required approvals, click the settings wheel in your workspace, in Workspace settings go into the Permissions tab and change the "Number of required approvals". Note that "Protected main branch" must be enabled to enable "Require admin approval".

Requiring multiple approvals can be used in combination with required admin approvals. In that case, the number of required approvals is the number of admins that need to approve the changes before the branch can be merged.

Multiple approvals required