开启 SQL Review Actions | Database CI/CD with GitHub 教程 ①

在基于 GitHub 的数据库 CI/CD 最佳实践中，我们提到从最基础的配置流程开始，带你走进 Database CI/CD 的世界 🌍。

这是系列教程的开篇。第一部分（下图中红色部分）将介绍如何为 GitHub 仓库开启 「SQL 审核」Actions（注：不需要部署 Bytebase 来完成第一部分操作）。这样，当有人给这个仓库提交 PR 时，SQL 审核将被自动触发。

完整的案例可以参考：https://github.com/Bytebase/sql-review-action-example

Step 1. 给 GitHub 仓库加入文件夹

在 GitHub Repo 中添加 2 个文件夹：

1. .github/workflows/ ：用于放置配置文件；
2. 和一个用于放置 .sql 文件的文件夹，此处样例取名为 github-action-test/。 

Step 2. 下载 SQL 审核模板

进入 SQL 审核规则网站：https://www.bytebase.com/zh/sql-review-guide，选择「指导方针 Dev」。

筛选出适用于 MySQL 的规则，点击右侧「保存为 YAML 文件」，你将得到 sql-review.yml 文件。

把下载的配置文件 sql-review.yml 移到你的 GitHub 仓库的根目录下。 
⚠️ 理论上可以把它放在仓库的任何地方，但是如果它在 .github/workflow/ 文件夹下的话，GitHub 可能会误认为它是一个配置文件，导致额外的混乱🐒。

Step 3. 修改配置文件

前往 GitHub Actions 市场：https://github.com/marketplace/actions/sql-review，并跟着「Usage」部分进行设置。

在你的 GitHub 仓库的目录中添加文件：.github/workflows/sql-review.yml ，并加入如下内容：

根据需求修改配置文件，此处主要需要修改最后四个参数：

• override-file-path
• template-id
• database-type

• file-pattern

Step 4. 触发 SQL 审核 Actions

1. 创建一个新分支；

2. 在 github-action-test 文件夹下加入（测试的）.sql 文件；

3. 提交并上传到远程，并在 GitHub 上创建一个 PR，SQL 审核 Actions 将被自动触发且运行。

4. 点击 Actions，可以看到这个文件被查出两个 Warning 等级的警告。

5. 因为它们是 Warning 级别的警告，你还是可以合并这个 PR。

⚠️ 如果想让这个警告阻止合并，可以采取以下任意一种方法：

1. 下载 SQL 审核规则配置文件模板前，调整错误等级至「错误」。

2. 直接在配置文件中编辑配置。

Congratulations! 你成功为 GitHub 仓库开启了 SQL 审核 Actions，之后每次给这个仓库提交 PR 时，「SQL 审核」都将被自动触发▶️。

本系列的下一篇文章，我们将探讨核心部分：如何使用 Bytebase 和 GitHub 打通数据库 GitOps。敬请关注。