Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates Bytebase 3.16.1 documentation by modernizing the Terraform “general settings” tutorial to use CEL-based Custom Approval rules (instead of Terraform risk policies), and makes a small changelog correction plus adds a Node version pin for docs tooling.
Changes:
- Remove the Terraform risk policy step from the “Manage General Settings with Terraform” tutorial and switch to CEL-based approval rules under
settings/WORKSPACE_APPROVAL. - Update 3.16.1 changelog database label for the schema dump fix.
- Add
docs/.node-versionto pin the Node major version for docs workflows.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/tutorials/manage-general-settings-with-terraform.mdx | Removes Terraform risk-policy section and documents CEL-based approval rules + updated verification notes |
| docs/changelog/bytebase-3-16-1.mdx | Changes the DB label for the pg_bitmapindex schema dump fix |
| docs/.node-version | Pins Node major version for docs tooling |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Fall back to DBA approval for all other operations | ||
|
|
||
| ### Step 4 - Apply Configuration | ||
| ### Step 3 - Apply Configuration |
There was a problem hiding this comment.
The step numbering is now inconsistent after removing the old Risk step: this section is labeled "Step 3", but the next heading is still "Step 5 - Verify Configuration". Please renumber the remaining steps so they are sequential (e.g., Apply = Step 3, Verify = Step 4) to avoid confusing readers.
| | Sample file | [approval_flow.tf](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/setup/approval_flow.tf) | | ||
|
|
||
| Create `4-3-approval-flow.tf` with approval flow configuration that requires multiple approvals for risky operations: | ||
| Create `4-2-approval-flow.tf` with approval flow configuration. Conditions are defined directly on each rule using CEL expressions: |
There was a problem hiding this comment.
The table links to a sample file named approval_flow.tf, but the tutorial instructs creating 4-2-approval-flow.tf. Consider aligning the filenames (or explicitly stating that the local filename is arbitrary and the linked file is just a reference) to reduce confusion.
| Create `4-2-approval-flow.tf` with approval flow configuration. Conditions are defined directly on each rule using CEL expressions: | |
| Create a local file (for example, `4-2-approval-flow.tf`) with the following approval flow configuration. Conditions are defined directly on each rule using CEL expressions: |
| This creates approval rules that: | ||
|
|
||
| - DML operations with MODERATE risk level | ||
| - DDL operations with HIGH risk level | ||
| - Require three-step approval (Project Owner -> DBA -> Admin) for database changes in production affecting 100+ rows | ||
| - Require Project Owner approval for exporting data from the `employee` table in production | ||
| - Fall back to DBA approval for all other operations |
There was a problem hiding this comment.
This section was updated to use approval rules/CEL conditions and no longer introduces Terraform risk policies, but the earlier "What You'll Learn" bullets still mention defining risk policies and risk-based approval flows. Please update that intro section to match the new approach (approval rules defined via CEL, without a separate risk-policy Terraform step).
No description provided.