Github PR 如何强制 check 项通过后才允许合入?
- User
Github PR 如何强制 check 项通过后才允许合入?
- Assistant
Github PR 强制 check 项通过后才允许合入,需要配置 Branch Protection Rules (分支保护规则)。 这种方式可以确保只有通过所有必需检查的 PR 才能合并到受保护的分支,从而提高代码质量和稳定性。
以下是详细的步骤和说明:
步骤:
-
进入你的仓库: 在 GitHub 网站上找到你的仓库。
-
导航到设置: 点击仓库页面顶部的 "Settings" (设置) 选项卡。
-
选择 "Branches" (分支): 在左侧的菜单中,找到并点击 "Branches" (分支)。
-
添加分支保护规则: 在 "Branch protection rules" (分支保护规则) 下,点击 "Add rule" (添加规则)。
-
配置分支保护规则: 填写以下关键信息:
-
Branch name pattern: 指定要保护的分支的名称或模式。 例如,你可以使用
main、develop或release/*等。 星号*是通配符,可以匹配多个分支。 -
Require pull request reviews before merging: (可选,但强烈推荐) 启用此选项后,必须经过指定数量的 reviewers 批准才能合并 PR。 你可以设置所需的批准人数。
-
Require status checks to pass before merging: 这是关键选项! 启用此选项后,所有必需的状态检查必须通过,才能合并 PR。
- Choose status checks: 在你启用 "Require status checks to pass before merging" 后,会出现一个列表,显示所有已在你的仓库上执行的状态检查。 这些状态检查通常由 CI/CD 工具(如 GitHub Actions、Travis CI、CircleCI 等)或其他集成工具创建。
- 选择需要强制通过的检查: 勾选你想要强制通过的每个状态检查。 请务必选择所有关键的检查,例如单元测试、代码风格检查、安全扫描等。
- Include administrators: (可选) 如果你希望即使是管理员也必须遵守这些规则,请勾选此选项。
-
Require conversation resolution before merging: (可选) 启用此选项后,所有代码审查的对话都必须解决才能合并 PR。这确保了所有问题都得到了解决。
-
Restrict who can push to matching branches: (可选) 这允许你限制哪些用户或团队可以直接推送代码到受保护的分支,而不是通过 PR。 一般情况下,建议不要直接推送,而是通过 PR 流程。
-
Require linear history: (可选) 这会阻止合并没有线性历史的 PR。 强制使用 rebase 或 squash 合并。
-
Allow force pushes: (可选) 强烈建议不要允许强制推送。 强制推送会覆盖远程分支的历史记录,这可能会导致问题。 只有在绝对必要的情况下才应允许强制推送。
-
Allow deletions: (可选) 允许删除受保护的分支。 一般不建议允许。
-
-
创建规则: 在配置完所有选项后,点击 "Create" (创建) 按钮。
工作原理:
一旦你创建了分支保护规则,GitHub 将会强制执行这些规则。
- 当一个 PR 被创建或更新时,GitHub 会自动运行配置的状态检查。
- 如果任何一个必需的状态检查失败,PR 将无法合并。 会显示一个错误消息,指示哪些检查失败。
- PR 的作者需要修复失败的检查,然后重新提交 PR。 CI/CD 系统会自动重新运行状态检查。
- 只有当所有必需的状态检查都通过,并且 PR 获得了所需的批准数量(如果配置了 review requirement),PR 才能被合并。
示例:
假设你有一个名为
main的分支,并且希望确保以下检查通过才能合并 PR:- 单元测试: 由 GitHub Actions 运行的单元测试。
- 代码风格检查: 由 SonarQube 或 ESLint 运行的代码风格检查。
- 安全扫描: 由 Snyk 或其他安全工具运行的安全扫描。
你需要配置分支保护规则,选择
main分支,启用 "Require status checks to pass before merging",并在列表中勾选 "单元测试"、"代码风格检查" 和 "安全扫描" 这三个状态检查。重要注意事项:
- 状态检查名称必须准确: 状态检查的名称必须与 CI/CD 工具或集成工具实际发布的名称完全一致。 如果名称不匹配,GitHub 将无法识别该检查,并且 PR 可能无法合并。
- 配置 CI/CD 工具: 确保你的 CI/CD 工具正确配置,以便在 PR 上自动运行状态检查,并将结果发布到 GitHub。
- 正确配置触发器: 确认 CI/CD 工作流配置为在 pull request 事件 (
pull_request或pull_request_target事件) 上触发。 这确保了每次 PR 创建或更新时都会运行检查。 - 状态检查完成后报告状态: CI/CD 工作流必须正确地将状态检查结果报告给 GitHub。 大多数 CI/CD 工具都提供了相应的 GitHub 集成功能。
- 合理设置状态检查: 不要设置过多的状态检查,否则可能会使合并 PR 变得过于复杂。 只选择那些真正重要的检查。
- 处理失败的检查: 当状态检查失败时,PR 的作者应该尽快修复问题,并重新提交 PR。 及时处理失败的检查可以确保代码质量和稳定性。
- 测试你的配置: 在将分支保护规则应用于生产分支之前,最好在一个测试分支上测试你的配置。 这可以帮助你确保规则按预期工作,并且不会阻止有效的 PR 被合并。
- 避免循环依赖: 某些状态检查可能依赖于其他状态检查的结果。 避免创建循环依赖关系,因为这可能导致死锁,使 PR 永远无法合并。
- 理解
pull_requestvspull_request_target:pull_request: 用于 PR 内的事件,例如代码修改。 使用此选项时,工作流会运行在 base 分支 (例如main) 的上下文中。 这意味着如果 PR 引入恶意代码,它也可能影响你的 CI/CD 工作流本身。pull_request_target: 用于 PR 的元数据事件,例如 PR 创建、评论等。 使用此选项时,工作流会运行在 head 分支 (PR 分支) 的上下文中,但具有更高的权限,可以访问 secrets。 此选项更安全,因为它不会受到 PR 代码的影响。
总结:
通过配置分支保护规则,你可以强制所有必要的检查通过后才能合并 PR,从而提高代码质量和稳定性。 务必仔细配置规则,选择正确的状态检查,并确保你的 CI/CD 工具正确配置,以便自动运行检查并将结果发布到 GitHub。 合理的配置可以显著提升你的开发流程和代码质量。
-
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.