docs: sync Terraform tutorials to provider 3.17.1 (round 2)#1079
Merged
adela-bytebase merged 5 commits intomainfrom Apr 16, 2026
Merged
docs: sync Terraform tutorials to provider 3.17.1 (round 2)#1079adela-bytebase merged 5 commits intomainfrom
adela-bytebase merged 5 commits intomainfrom
Conversation
Fix remaining drift between docs MDX snippets and provider schema: - Part 1: Remove non-existent checkers block and invalid policy types - Part 3: Replace removed project fields with current schema - Part 4: Remove bytebase_risk, fix approval flow to use roles list - Part 5: Replace JSON string payloads with typed payload fields - Part 6: Remove type field from bytebase_user, add service_account/workload_identity - Part 7: Fix workspace parent, service account prefix, add workload identity - Part 8: Add resource. prefix to CEL conditions, remove actions field, fix exemptions Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
2 tasks
ecmadao
approved these changes
Apr 16, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Terraform tutorial MDX files to align with terraform-provider-bytebase v3.17.1 schema changes (new resources, renamed/removed fields, typed payloads, and updated CEL/IAM formats).
Changes:
- Update tutorial Terraform examples to use current resources/fields (e.g.,
bytebase_service_account,bytebase_workload_identity, typed rule payloads). - Remove/replace obsolete concepts and resources (e.g.,
bytebase_risk, old approval-flow block structures, masking exception → exemption). - Adjust policy/resource examples to current enums and CEL/member formats.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorials/manage-users-and-groups-with-terraform.mdx | Updates user/service-account/workload-identity examples and key points. |
| docs/tutorials/manage-sql-review-rules-with-terraform.mdx | Migrates SQL review rule types and payloads to typed fields. |
| docs/tutorials/manage-projects-with-terraform.mdx | Updates project configuration fields, labels, and webhook notification types. |
| docs/tutorials/manage-general-settings-with-terraform.mdx | Removes risk policy section and updates approval flow schema example. |
| docs/tutorials/manage-environments-with-terraform.mdx | Updates rollout and data protection policy examples to current policy types/fields. |
| docs/tutorials/manage-database-access-control-with-terraform.mdx | Updates IAM examples for service accounts/workload identities and member prefixes. |
| docs/tutorials/manage-data-masking-with-terraform.mdx | Updates classification schema, masking rule CEL, and masking exemption policy example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Part 1: Update provider version from 3.8.6 to 3.17.1 - Part 2: Fix data source IDs to match tutorial .tf files - Part 4: Fix external_url placeholder to match tutorial Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Fix stale "exception" wording and file link to match the actual tutorial filename (8-5-masking-exemption.tf). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Part 4: Mark source as optional in approval flow description - Part 6: Add resource table for bytebase_service_account and bytebase_workload_identity Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The Advanced Configuration section used old-style lowercase dot-separated rule type (table.require-pk) instead of UPPERCASE (TABLE_REQUIRE_PK), inconsistent with the rest of the tutorial. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
terraform-provider-bytebaseschema andtutorials/*.tffilesbytebase_risk), removed fields (typeon user,actionson exemptions,checkerson rollout), and obsolete block structures (steps/conditionson approval flow)resource.prefix), policy types (DATA_QUERYreplacesDISABLE_COPY_DATA/DATA_SOURCE_QUERY), payload format (typed fields replace JSON strings), and IAM member prefixes (serviceAccount:,workloadIdentity:)Test plan
tutorials/*.tfin provider repoCompanion provider PR to follow with
.tffile fixes.🤖 Generated with Claude Code