Skip to content

Commit f903b9c

Browse files
docs: update rollout policy from env to project (#972)
* update rollout policy from env to project * update * Update docs/change-database/environment-policy/rollout-policy.mdx Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent 1259676 commit f903b9c

File tree

1 file changed

+18
-28
lines changed

1 file changed

+18
-28
lines changed

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

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,28 @@ title: Rollout Permissions
99
horizontal
1010
/>
1111

12-
Configure who can deploy database changes and what conditions must be met before rollout can proceed in each environment.
12+
Configure who can deploy database changes and what conditions must be met before rollout can proceed in Environment and Project.
1313

14-
## Role-based rollout
14+
## Configure rollout policy in Environment
1515

16-
### Default roles with permissions
16+
### Role-based manual rollout
1717

18-
Users with the `bb.taskRuns.create` permission can perform rollouts. The following roles have this permission by default:
18+
**Default roles with permissions**: Users with the `bb.taskRuns.create` permission can perform rollouts. The following roles have this permission by default: `Workspace Admin`, `Workspace DBA`, `Project Releaser`.
1919

20-
- Workspace Admin
21-
- Workspace DBA
22-
- Project Releaser
20+
**Environment-specific roles**: If you want to use different roles to perform rollouts in different environments, you can specify environment-specific roles. This allows you to control who can deploy changes to specific environments, such as having different teams responsible for staging versus production deployments.
2321

24-
### Environment-specific roles
22+
### Automatic rollout
2523

26-
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.
24+
Enable automatic deployment when all checks pass by selecting the `automatic` option. This will automatically deploy changes when:
25+
26+
- All required approvals are obtained (if "Require Issue Approval" is enabled)
27+
- Plan checks pass according to the configured enforcement policy
28+
29+
<Note>
30+
Do not enable automatic rollout when using the GitOps workflow, as it can cause conflicts that result in failures.
31+
</Note>
2732

28-
## Configurable rollout requirements
33+
## Configurable rollout requirements in Project
2934

3035
Configure what conditions must be met before changes can be rolled out in each environment:
3136

@@ -35,27 +40,12 @@ Ensures all changes are reviewed and approved before deployment to production en
3540

3641
**Default**: Enabled
3742

38-
### Plan check enforcement
43+
### Require plan check no error
3944

40-
Controls how rollout behaves based on plan check results, including SQL Review policy violations and other validations:
45+
Controls how rollout behaves based on plan check results, including SQL Review policy violations and other validations. When enabled, rollout is blocked if checks return errors, but warnings still allow rollout.
4146

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+
**Default**: Enabled
4748

4849
<Note>
4950
Plan checks include [SQL Review policy](/sql-review/review-policy) violations and other automated validations configured for your environment.
50-
</Note>
51-
52-
## Automatic rollout
53-
54-
Enable automatic deployment when all checks pass by selecting the `automatic` option. This will automatically deploy changes when:
55-
56-
- All required approvals are obtained (if "Require Issue Approval" is enabled)
57-
- Plan checks pass according to the configured enforcement level
58-
59-
<Note>
60-
Do not enable automatic rollout for GitOps Workflow as it can cause conflicts that result in failures.
6151
</Note>

0 commit comments

Comments
 (0)