攻略｜三种集成 SQL Review 到 GitHub 的模式，哪种最适合你

SQL 脚本的审核是数据库变更过程中极为关键的一环，以往这一工作完全由 DBA 负责，经常是在上线的前一刻才由开发者提交到 DBA 侧，时效性的不足导致难以确保变更质量，甚至一些团队由于缺少专业 DBA 而完全跳过了这一环节。Bytebase 作为一款面向研发团队打造的数据库 CI/CD 工具，致力于赋能开发者完成高质量的数据库变更工作，产品内置了强大的自动 SQL 审核能力。

• GitHub Action
• GitHub App

• GitOps SQL Review CI

1. 获取 GitHub Action workflow 文件

完成配置后，当用户提交的 PR 中检测出 SQL，即可自动触发审核过程，并在被审核的文件中查看详细审核结果。

❌ 仅实现 CI。该模式只实现 SQL 审核，无法触发后续的 SQL 部署流程。

Bytebase 实现了基于 App 的自动化审核，只需部署对应 App 并关联对应代码仓库，即可将 SQL 审核规则集成到 CI 流程中。

1. 部署 GitHub App

Bytebase 已经上架 GitHub App (https://www.bytebase.com/docs/sql-review/sql-advisor/github-app)，可以访问链接直接部署该 APP。

2. 关联指定仓库激活 SQL 审核

用户可以在 APP 的配置页面关联指定的代码仓库，即可激活审核能力。

3. 自定义 SQL 审核规范

用户可以通过 GitHub 账号登录 hub.bytebase.com 进行可视化自定义规范配置，所有修改即时生效。

详细配置过程可查看文档 GitHub-App: https://www.bytebase.com/docs/sql-review/sql-advisor/github-app

❌ 仅实现 CI。该模式只实现 SQL 审核，无法触发后续的 SQL 部署流程。

基于 Bytebase Console 的集成模式提供了更强大的功能，该模式可以一键自动配置 GitHub Action，同时支持与待变更的数据库通信，进而实现更高级的审核项与后续 CD 流程。

1. 部署 Bytebase Console 并完成基础配置

该模式需要完成 Bytebase Console 的部署，并进行基础配置将相应数据库纳入管理，详细过程可查看部署文档 Bytebase Installation Guide (https://www.bytebase.com/docs/get-started/install/overview)。

2. 一键激活 SQL Review CI

在 Bytebase Console 的 Project 配置页面中通过配置 GitOps Workflow 即可自动生成 GitHub PR 完成 GitHub Action 的配置，无需进行任何繁琐的文件编辑。

3. 自定义 SQL 审核规范

如果不满足于默认审核规范，在 Bytebase Console 中可以进行可视化自定义规范配置，所有修改即时生效。

详细配置过程可查看文档 GitOps-CI: https://www.bytebase.com/docs/sql-review/sql-advisor/gitops-ci

完成配置后，当用户按照指定格式提交 SQL 脚本，即可自动触发审核过程，并在被审核的文件中查看审核结果

❌ 展示方式较单一。只能在被审核文件中查看审核结果，缺乏审核结果总览。