You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/change-database/environment-policy/rollout-policy.mdx
+18-28Lines changed: 18 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,23 +9,28 @@ title: Rollout Permissions
9
9
horizontal
10
10
/>
11
11
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.
13
13
14
-
## Role-based rollout
14
+
## Configure rollout policy in Environment
15
15
16
-
### Default roles with permissions
16
+
### Role-based manual rollout
17
17
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`.
19
19
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.
23
21
24
-
### Environment-specific roles
22
+
### Automatic rollout
25
23
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>
27
32
28
-
## Configurable rollout requirements
33
+
## Configurable rollout requirements in Project
29
34
30
35
Configure what conditions must be met before changes can be rolled out in each environment:
31
36
@@ -35,27 +40,12 @@ Ensures all changes are reviewed and approved before deployment to production en
35
40
36
41
**Default**: Enabled
37
42
38
-
### Plan check enforcement
43
+
### Require plan check no error
39
44
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.
41
46
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
47
48
48
49
<Note>
49
50
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.
0 commit comments