Skip to content

Commit be0450e

Browse files
authored
docs: update rollout policy (#906)
* docs: update rollout policy * chore: update * chore: update
1 parent 4704eab commit be0450e

File tree

3 files changed

+38
-6
lines changed

3 files changed

+38
-6
lines changed

mintlify/change-database/approval.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,7 @@ Navigate to **Settings > Custom Approval > Rules**
7777
In your project settings, consider:
7878

7979
- **Self-approval**: By default, users cannot approve their own changes. [Enable self-approval](/change-database/settings#self-approval) only if your process allows it
80-
- **Rollout Policy**: Define whether approved changes deploy automatically or require manual trigger via [rollout policy](/change-database/environment-policy/rollout-policy/)
80+
- **Rollout Policy**: Configure rollout requirements and permissions via [rollout policy](/change-database/environment-policy/rollout-policy/), including:
81+
- Whether issue approval is required before rollout
82+
- How plan checks should be enforced (block on errors only, errors and warnings, or allow rollout regardless)
83+
- Whether changes deploy automatically or require manual trigger

mintlify/change-database/environment-policy/rollout-policy.mdx

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,52 @@ title: Rollout Permissions
99
horizontal
1010
/>
1111

12-
Configure who can deploy database changes in your environment through rollout permissions. You can choose between role-based deployment by authorized users or automatic deployment when all checks pass.
12+
Configure who can deploy database changes and what conditions must be met before rollout can proceed in each environment.
1313

1414
## Role-based rollout
1515

1616
### Default roles with permissions
1717

1818
Users with the `bb.taskRuns.create` permission can perform rollouts. The following roles have this permission by default:
19+
1920
- Workspace Admin
20-
- Workspace DBA
21+
- Workspace DBA
2122
- Project Releaser
2223

2324
### Environment-specific roles
2425

2526
If you want to use different roles to perform rollouts in different environments, you can specify environment-specific roles in the Environment policy settings. This allows you to control who can deploy changes to specific environments, such as having different teams responsible for staging versus production deployments.
2627

28+
## Configurable rollout requirements
29+
30+
Configure what conditions must be met before changes can be rolled out in each environment:
31+
32+
### Require issue approval
33+
34+
Ensures all changes are reviewed and approved before deployment to production environments. When enabled, issues must receive approval before rollout can proceed.
35+
36+
**Default**: Enabled
37+
38+
### Plan check enforcement
39+
40+
Controls how rollout behaves based on plan check results, including SQL Review policy violations and other validations:
41+
42+
- **Block on errors only** (default): Rollout is blocked if checks return errors, but warnings still allow rollout
43+
- **Block on errors and warnings**: Rollout is blocked if checks return either errors or warnings
44+
- **Allow rollout regardless**: Rollout can proceed even if checks return errors or warnings
45+
46+
**Default**: Block on errors only
47+
48+
<Note>
49+
Plan checks include [SQL Review policy](/sql-review/review-policy) violations and other automated validations configured for your environment.
50+
</Note>
2751

2852
## Automatic rollout
2953

30-
Enable automatic deployment when all checks pass by selecting the `automatic` option. Failed checks will block automatic rollout:
54+
Enable automatic deployment when all checks pass by selecting the `automatic` option. This will automatically deploy changes when:
3155

32-
- [SQL Review policy](/sql-review/review-policy) violations
56+
- All required approvals are obtained (if "Require Issue Approval" is enabled)
57+
- Plan checks pass according to the configured enforcement level
3358

3459
<Note>
3560
Do not enable automatic rollout for GitOps Workflow as it can cause conflicts that result in failures.

mintlify/change-database/scheduled-rollout.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,11 @@ This separation of concerns ensures that developers focus on creating quality mi
3333

3434
![rollout-schedule](/content/docs/change-database/scheduled-rollout/bb-rollout.webp)
3535

36-
If there are any warnings or errors, as long as you check **Rollout anyway**, you can still schedule the time.
36+
If there are any warnings or errors, your ability to proceed depends on the [Plan Check Enforcement](/change-database/environment-policy/rollout-policy#plan-check-enforcement) settings configured for the environment:
37+
38+
- **Block on errors only**: You can proceed if there are only warnings
39+
- **Block on errors and warnings**: You must resolve all errors and warnings before scheduling
40+
- **Allow rollout regardless**: You can proceed even with errors or warnings
3741

3842
![rollout-schedule-anyway](/content/docs/change-database/scheduled-rollout/bb-rollout-anyway.webp)
3943

0 commit comments

Comments
 (0)