Skip to content

Commit f5dce24

Browse files
update plan
1 parent 854025e commit f5dce24

File tree

8 files changed

+13
-23
lines changed

8 files changed

+13
-23
lines changed

docs/change-database/plan.mdx

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,29 @@ title: Plan
55
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.
66

77
### 1. Create a New Plan
8-
In your project, go to **CI/CD** > **Plans** in the left menu and click **New Plan**.
98

10-
![new-plan](/content/docs/change-database/plan/bb-new-plan.webp)
9+
In your project, go to **CI/CD** > **Plans** in the left menu and click **+ New Plan**.
1110

12-
### 2. Choose the Change Type
13-
Select either **Schema Migration (DDL)** or **Data Migration (DML)**. After adding the first change, you can continue to add more.
11+
### 2. Select Target Databases
1412

15-
![plan-change-type](/content/docs/change-database/plan/bb-plan-change-type.webp)
16-
17-
### 3. Select Target Databases
1813
Choose one or more databases where the changes will be applied. Click **Confirm** to proceed.
1914

20-
![plan-targets](/content/docs/change-database/plan/bb-plan-targets.webp)
15+
### 3. Add Changes
2116

22-
### 4. Add Changes
23-
Fill in the SQL statement. You can add multiple changes to the same plan. Once done, click **Create**.
17+
Add SQL statements (multiple allowed). Click **Create** to convert the plan into an issue. SQL review runs automatically, showing any warnings.
2418

25-
![plan-add-change](/content/docs/change-database/plan/bb-plan-add-change.webp)
26-
![plan-2-change](/content/docs/change-database/plan/bb-plan-2-change.webp)
19+
![bb-plan-warning-detail](/content/docs/change-database/plan/bb-plan-warning-detail.webp)
2720

28-
### 5. Submit for Review
29-
The plan starts in a `draft` state. Click **Ready for Review** to submit it for approval.
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).
3024

31-
![plan-draft](/content/docs/change-database/plan/bb-plan-draft.webp)
25+
![plan-approval](/content/docs/change-database/plan/bb-plan-approval.webp)
3226

33-
### 6. Approve and Roll Out
34-
Once approved, go to the **Rollout** section to begin deployment.
27+
### 5. Deploy to Environments
3528

36-
![plan-approval](/content/docs/change-database/plan/bb-plan-approval.webp)
37-
![plan-ready-rollout](/content/docs/change-database/plan/bb-plan-ready-rollout.webp)
29+
Once approved, go to the **Rollout** section to begin deployment.
3830

39-
### 7. Deploy to Environments
40-
First, deploy to the `Test` environment. If successful, proceed to deploy to `Prod`.
31+
![bb-issue-2-targets-to-rollout](/content/docs/change-database/plan/bb-issue-2-targets-to-rollout.webp)
4132

42-
![plan-rollout-test](/content/docs/change-database/plan/bb-plan-rollout-test.webp)
43-
![plan-rollout-prod](/content/docs/change-database/plan/bb-plan-rollout-prod.webp)
33+
First, deploy to the `Test` environment. If successful, proceed to deploy to `Prod`.
18.6 KB
Loading
-61.6 KB
Binary file not shown.
-58.1 KB
Binary file not shown.
-70.4 KB
Binary file not shown.
-46.8 KB
Binary file not shown.
-49.4 KB
Binary file not shown.
7.84 KB
Loading

0 commit comments

Comments
 (0)