Skip to content

Commit d2d8fea

Browse files
update
1 parent 8bbcaf8 commit d2d8fea

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/change-database/plan.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,32 @@
22
title: Plan
33
---
44

5-
A **Plan** is the core component of Bytebase’s CI/CD pipeline. It defines a series of schema or data changes to be applied to one or more databases.
5+
A **Plan** is the core component of Bytebase’s CI/CD pipeline. It defines a series of schema or data changes to be applied to one or more databases. It can be converted into an **Issue** for review and deployment.
66

7-
### 1. Create a New Plan
7+
### 1. Create Plan
88

9-
In your project, go to **CI/CD** > **Plans** in the left menu and click **+ New Plan**.
9+
In your project, navigate to **CI/CD** > **Plans** and click **+ New Plan**.
1010

11-
### 2. Select Target Databases
11+
### 2. Select Databases
1212

13-
Choose one or more databases where the changes will be applied. Click **Confirm** to proceed.
13+
Choose one or moretarget databases and click **Confirm**.
1414

1515
### 3. Add Changes
1616

17-
Add SQL statements (multiple allowed). Click **Create** to convert the plan into an issue. SQL review runs automatically, showing any warnings.
17+
Add SQL statements (multiple allowed by clicking **+ Add Change**) and click **Create**. The plan becomes an issue with automatic SQL review.
1818

1919
![bb-plan-warning-detail](/content/docs/change-database/plan/bb-plan-warning-detail.webp)
2020

21-
### 4. Submit for Review waiting for approval (Enterprise)
22-
s
23-
Click **Ready for Review** to submit it for approval. The issue awaits approval per [configured rules](/change-database/approval).
21+
### 4. Submit for Review (Enterprise)
22+
23+
Fix the warning, and click **Ready for Review**. Approval follows [configured rules](/change-database/approval).
2424

2525
![plan-approval](/content/docs/change-database/plan/bb-plan-approval.webp)
2626

27-
### 5. Deploy to Environments
27+
### 5. Deploy
2828

29-
Once approved, go to the **Rollout** section to begin deployment.
29+
After approval, go to the **Rollout** section to deploy changes. You may configure the rollout policy to `Automatic` in the [environment](/change-database/environment-policy/rollout-policy).
3030

3131
![bb-issue-2-targets-to-rollout](/content/docs/change-database/plan/bb-issue-2-targets-to-rollout.webp)
3232

33-
First, deploy to the `Test` environment. If successful, proceed to deploy to `Prod`.
33+
Deploy to `Test` first, then `Prod` after success.

0 commit comments

Comments
 (0)