Change Request Policies

📷

Requires an upgraded subscription

This feature is exclusive to our Enterprise Plan. Book a demo to see it in action.

When creating a workflow for your change requests, you can create policies that:

• Designate how many users are required to approve a change request before it can be merged along with who those approvers can be (either explicitly named users or by group).
• Prevent the creator of a change request from approving their own request.

These policies can be setup globally across all projects and configs or on an individual project and config basis.

Permissions

In order to create or modify policies, a user needs both workplace permissions listed below. This will let them create policies or modify them, but won't allow them to assign those policies to any projects or configs. For that, they need the project permission listed below as well.

📘

Users with the Assign Change Request Policies are only able to assign policies to projects and configs they otherwise have access to.

Workplace

Project

Creating a new policy

To create a new change request policy:

1. Browse to the Change Requests area of the dashboard.

2. Click on the Policies navigation item that appears.

3. Click the + New Policy button.

   

4. Provide a name for the policy and optionally provide a description. The description is shown in the policy list view, so it can be helpful to understand a policy when looking through a large number on the list view page.

   

5. Configure your policy rule by setting the number of approvers, the pool of approvers (which can be specific users or entire groups) and optionally checking the Do not allow self-approvals option to prevent users from opening a change request and then approving it themselves.

   

6. You can optionally add additional rules to the policy by clicking the + button in the top right corner (click the red X next to additional rules to remove them).

   

7. After configuring the rules, assign the policy to the projects and configs it should apply to. You can choose to enable it for an entire project (which includes all current and future environments and branch configs in the project), specific environments (which includes all current and future branch configs under that environment), or just specific branch configs. Choosing the Apply to all projects checkbox will enable the policy for all projects, environments, and branch configs in the workplace.

   📘

   Only projects your user has access to will display in the policy assignment area. Additionally, the Apply to all projects checkbox is only enabled if your user has either the Admin on All Projects workplace permission or if the user has the Access All Projects workplace permission and the default project role for the workplace has the Access All Configs permission. Your user will also need to have the Assign Change Request Policies project permission before any projects will show up in this area.

   

8. Finally, click the Save Policy button at the top of the page.

   

The policy will now be applied to all change requests that target the projects, environments and configs the policy was assigned to. The policy will be indicated above the change preview in the change request.

Changes not impacted by a policy can be approved and merged without any limitations, but changes inside a change request that are impacted can't be merged until all the policy requirements are met.

Combining policies

In addition to adding multiple rules to a single policy, you can also target the same projects, environments, and branch configs with multiple policies. The status for each is displayed separately and once all of a policy's rules are met, its color shifts from gray to green.

Each policy must be fulfilled before the change in the change request will be mergeable. Until then, the Merge button will be disabled.

Managing existing policies

You can view or modify existing policies from the main change request policies page.

Clicking on a policy in the list view will take you to a page where you can modify the policy's configuration. To delete the policy, you can click the Delete button directly to the left of the Save Policy button.

Policy warnings

You may run into situations where a change request has assigned reviewers who don't have the necessary access for the change being reviewed. If this happens, you'll see a yellow warning icon with hover text explaining what's wrong.