CI/CD / 系统课时

给 Pull Request 配置检查

给 Pull Request 配置检查

Pull Request 在创建、追加提交和重新打开时都可能需要重新验证代码。通过 pull_request 事件,可以把测试、静态检查等任务绑定到 PR 生命周期,让合并前的代码持续接受自动检查,而不必等代码进入主分支后再发现问题。

学习目标

  • 使用 pull_request 为 Pull Request 建立自动检查工作流
  • 用 types 和 branches 精确限定需要响应的 PR 活动
  • 理解 PR 事件、工作流检查与仓库合并规则之间的关系

建立 Pull Request 检查

最常见的做法是在 PR 创建、重新打开或源分支出现新提交时执行测试。pull_request 默认会响应常用的 PR 活动,因此基础配置不必显式罗列这些活动类型。

yaml
name: Pull Request Checks

on:
  pull_request:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run validation
        run: echo "PR checks passed"

预期输出

text
PR checks passed

当 Pull Request 的目标分支是 main 时,该工作流会创建 test Job。这里 branches 过滤的是 PR 的目标分支,不是提交代码所在的源分支;例如从 feature/login 向 main 发起 PR,可以匹配上述规则。

PR 更新时为什么会重新检查

PR 不是一次性事件。开发者可能在评审过程中继续向源分支推送提交,此时需要让新代码重新经过验证,否则页面上的旧测试结果不能代表当前版本。

Pull Request 更新与检查触发流程

对于常规代码检查,这种自动重跑正是期望行为:每一次改变 PR 当前提交集合的操作,都应该使验证结果重新对应最新代码。

用 types 限制活动类型

如果任务只关心某些 PR 活动,可以显式设置 types。例如下面的工作流仅在 PR 首次打开、重新打开以及源分支更新时运行:

yaml
name: Selected PR Checks

on:
  pull_request:
    types:
      - opened
      - reopened
      - synchronize

jobs:
  inspect:
    runs-on: ubuntu-latest
    steps:
      - run: echo "Validate current PR revision"

预期输出

text
Validate current PR revision

其中 synchronize 是容易忽略但很重要的活动:向已经存在 PR 的源分支推送新提交时,会触发这一活动。若自行收窄 types 却漏掉它,首次创建 PR 时检查正常,后续追加代码却可能不再执行。

把多个检查拆成独立 Job

实际项目通常不只有一个测试命令。可以把不同性质的检查拆成多个 Job,让 PR 页面分别呈现结果,也便于定位失败环节。下面是片段示例,依赖同一工作流中的 pull_request 触发配置以及实际项目对应的测试命令:

yaml
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: ./scripts/lint.sh

  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: ./scripts/test.sh

生效后会产生 lint 与 test 两个独立 Job。验证时应查看对应 PR 的 Checks 或 Actions 运行结果,确认两个 Job 都针对当前提交执行;具体控制台输出由项目脚本决定,不应预设固定文本。

让检查真正约束合并

工作流运行成功并不等于 GitHub 自动禁止失败 PR 合并。Actions 负责产生检查结果,而“必须通过哪些检查才能合并”属于仓库的分支保护或 Ruleset 配置。两者配合后,才形成从 PR 更新、自动验证到满足规则后允许合并的完整约束。

设计 PR 流水线时,应先确定哪些验证必须覆盖每次代码更新,再决定是否通过 types、分支或路径过滤缩小触发范围。这样既能减少无意义执行,也不会因为过滤条件过窄而让最新代码绕过必要检查。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

给 Pull Request 配置检查

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通