Skip to content

Conversation

@d-bytebase
Copy link
Contributor

Summary

  • Complete rewrite of the Database CI/CD overview page (change-workflow.mdx)
  • Improved structure and clarity to help users understand and choose between workflows
  • Added comprehensive lifecycle explanation that applies to both UI-Driven and GitOps workflows

Changes Made

Structure Improvements

  • Added 6-step Database CI/CD lifecycle section showing the common process
  • Moved Database Groups/batch changes explanation before workflow selection
  • Clear separation between shared capabilities and workflow-specific features

Content Enhancements

  • Plan Change: Clarified targeting options (single, multiple, or Database Groups)
  • SQL Review: Added syntax validation and comprehensive check categories
  • Approval Process: Explained approval options for each workflow (including ServiceNow/Jira for GitOps)
  • Multi-Environment Pipeline: Detailed stage-by-stage promotion with orchestration
  • Rollback: Specified DML instant rollback and schema rollback capabilities
  • Schema Monitoring: Focused on drift detection

User Experience

  • Clear decision criteria with "Choose X If" sections
  • Removed technical jargon (replaced "VCS" with "Git provider" with examples)
  • Added "Can I Use Both?" section for hybrid approaches
  • Removed outdated concepts and implementation details from overview

Test Plan

  • Preview the documentation locally
  • Verify all internal links work correctly
  • Ensure consistency with existing documentation structure

🤖 Generated with Claude Code

Complete rewrite of the change-workflow.mdx overview page to better explain
Bytebase's Database CI/CD capabilities and help users choose between workflows.

Key improvements:
- Added comprehensive 6-step CI/CD lifecycle that applies to both workflows
- Clear comparison between UI-Driven and GitOps workflows with decision criteria
- Introduced Database Groups concept for batch changes at scale
- Removed outdated concepts and technical details from overview
- Replaced VCS acronym with "Git provider" for better clarity
- Focused on helping users make informed workflow decisions

The page now serves as a proper overview that explains the common CI/CD
process before diving into specific workflow choices.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@vercel
Copy link

vercel bot commented Aug 28, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
bytebase-com Ready Ready Preview Comment Aug 28, 2025 7:32am

@github-actions
Copy link

📝 Broken Links Check Report

Note: Entries under /api-reference/ are likely false positives and can be ignored.

The following is the output from the broken links check:

found 18 broken links in 10 files

change-database/change-workflow.mdx
 ⎿  /change-database/ui-workflow
 ⎿  /change-database/gitops-workflow

integrations/api/audit-log.mdx
 ⎿  /api-reference/auditlogservice/post-v1auditlogs:search

integrations/api/authentication.mdx
 ⎿  /api-reference/authservice/post-v1authlogin

integrations/api/data-classification.mdx
 ⎿  /api-reference/settingservice/patch-v1settings
 ⎿  /api-reference/databaseservice/patch-v1instances-databases

integrations/api/issue.mdx
 ⎿  /api-reference/issueservice/post-v1projects-issues

integrations/api/permission.mdx
 ⎿  /api-reference/workspaceservice/get-v1workspaces-:getIamPolicy
 ⎿  /api-reference/projectservice/get-v1projects-:getIamPolicy
 ⎿  /api-reference/roleservice/get-v1roles
 ⎿  /api-reference/userservice/get-v1users
 ⎿  /api-reference/groupservice/get-v1groups

integrations/api/plan.mdx
 ⎿  /api-reference/planservice/post-v1projects-plans
 ⎿  /api-reference/sheetservice/post-v1projects-sheets

integrations/api/release.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases

integrations/api/rollout.mdx
 ⎿  /api-reference/rolloutservice/post-v1projects-rollouts

integrations/api/sql-review.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases:check
 ⎿  /api-reference/sqlservice/post-v1sqlcheck

@d-bytebase d-bytebase merged commit f893f7c into main Aug 28, 2025
5 checks passed
@d-bytebase d-bytebase deleted the improve-database-cicd-overview branch August 28, 2025 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants