DEV Community

Wen Ping
Wen Ping

Posted on Edited on Originally published at anguskit.com

合并请求怎么触发流水线:红了还能不能合

这篇讲拉取请求的合并按钮为什么是灰的,以及流水线已经失败了为什么有时还能合并。看完你可以在 YAML 里加上 on: pull_request 和 checkContext,让流水线自动跑并把结果写回状态检查;要把「必须通过」变成谁都绕不过的规则,再把同样的检查名称填进分支保护。

状态检查是拉取请求对话页上的一张卡片:每一行对应一项检查,左边是名称,右边是 进行中、成功 或 失败。流水线在团队版和企业版中提供;社区版没有 CI/CD 菜单,本文的操作不适用。

源分支推送后,合进 main 的拉取请求跑状态检查;成功之后还要等评审才能合并

后面的界面截图都来自 xlliu/test-cicd-example 的拉取请求 #1,源分支 verify-pr-sc0204,目标分支 main。

1. 在 YAML 里加上 pull_request 触发器

version: "1"
name: ci
checkContext: ci
triggers:
  - on: push
    branches: [main]
  - on: pull_request
    branches: [main]
pipeline:
  build:
    runner:
      mode: DOCKER
      image: repo.anguskit.com/docker-public/angus-ci-maven:21
      labels: ["linux", "docker"]
    steps:
      - name: Build and test
        run: mvn -B -ntp clean verify
        timeout: 1800
Enter fullscreen mode Exit fullscreen mode

上面这段是最小写法,检查名称会显示成 ci。后面截图里的两条检查名,来自仓库里另外两份真实文件 .anguscicd/02-matrix-build.yaml 和 .anguscicd/04-monorepo-change.yaml,不是这里的 ci。

和拉取请求有关的是两处:

  • on: pull_request 和 branches: [main]。 这里的 branches 匹配的是拉取请求的 目标分支,不是源分支。上面的写法表示:凡是要合进 main 的拉取请求,都跑这条流水线;源分支叫什么都可以。
  • checkContext: ci。 这是这条流水线写回拉取请求时用的检查名称。不写时用流水线的名称。后面配分支保护时要填一模一样的名字,所以建议显式写上,以后改流水线名称也不会影响分支保护。

流水线读取的是拉取请求 源分支 上的 YAML。所以在源分支上修改已有流水线的 YAML,这条拉取请求跑的就是修改后的版本,可以先在拉取请求里试验新的配置,确认没问题再合并。前提是这条流水线已经在 CI/CD → 流水线 里建立过;全新的 YAML 只放在源分支上,不会凭空生成一条流水线。

2. 什么时候会跑

加上触发器之后,不是每次点开拉取请求都会重新跑一遍。常见动作和是否触发如下。

发生了什么 会不会触发 说明
发起一条合并到 main 的拉取请求 会 目标分支匹配 branches: [main]
往这条拉取请求的源分支推送新提交 会 按最新提交重新运行并更新状态检查
关闭后重新打开拉取请求 会 重新触发状态检查
发起草稿拉取请求 会 草稿不能合并,但流水线照常运行
草稿拉取请求点 标记为可评审 视是否跑过而定 该提交在草稿阶段已经跑过时不会重复跑
同一个提交已经跑过一次 不会重复跑 可在运行详情点 重跑
拉取请求合并到 develop 等其他分支 不会 除非 branches 里也写了那个目标分支

3. 结果在哪看

打开拉取请求的对话页,就能看到前面说的 状态检查 卡片。每一行左边是检查名称(例如 ci),右边是 进行中、成功 或 失败。

示例里的 #1 有两条成功的状态检查:.anguscicd/02-matrix-build.yaml 和 .anguscicd/04-monorepo-change.yaml。合并卡仍然写着「此拉取请求尚未准备好合并」,原因不是流水线,而是「仍有评审未完成,需等待评审通过后才能合并」。合并拉取请求 是灰的。检查失败时,同一张卡会改成「所有必需的状态检查必须通过」,说明文字是 Job(s) failed。

拉取请求 #1:两条状态检查都成功,合并按钮因为评审未完成而不可用

页面下方的合并卡里也列出这些检查,格式是「名称 - 说明」,例如 ci - Pipeline passed 或 ci - Job(s) failed。说明文字是英文的,由流水线结束时写入。

状态检查这一行不能直接点进流水线。要看是哪一步失败了,到 CI/CD → 流水线,点这条流水线的名称,在 运行记录 里把 触发方式 筛选为 合并请求,找到对应分支最新的那次运行,点进去看任务和日志。看日志定位错误的方法,见文末参考里的流水线失败排查一文。

4. 红了还能不能合

先说网页上的合并按钮:拉取请求上只要有一项检查不是 成功,进行中 也算,合并卡就显示「此拉取请求尚未准备好合并」,并提示「所有必需的状态检查必须通过」,合并按钮不可用。对通过网页合并的人来说,流水线红了就合不了。

但这只是网页上的限制。通过接口合并,或者仓库管理员在没有开启 对管理员同样生效 的情况下合并,是否会被拦住,要看分支保护。要让「流水线必须通过」成为谁都绕不过去的规则,按下面配置。

  1. 打开分支保护 仓库 设置 → 分支保护,编辑 main 的规则;还没有规则就新建一条。
  2. 要求状态检查通过 打开 需要状态检查通过,说明是「合并前所有状态检查必须通过」。在 必需的状态检查上下文 里填 ci。有多条流水线都必须通过时,用逗号分隔,例如 ci,lint。
  3. 对管理员也生效 打开 对管理员同样生效。不打开时,仓库管理员通过接口合并可以绕过保护规则。
  4. 保存 保存规则。规则列表里这条规则会显示 需要状态检查通过 的标记。

分支保护:main 要求状态检查 ci,并对管理员生效

这张图是 xlliu/test-cicd-example 的 添加分支保护规则。分支选了 main,需要状态检查通过 已打开,必需的状态检查上下文 填了 ci,对管理员同样生效 已打开。允许强制推送 和 允许删除 保持关闭。打开状态检查之后,对话框里还会出现 需要最新分支,这张图里没有打开。这个仓库当时还没有已保存的规则,图里是点 添加规则 之前的表单。填好后再保存。

配好之后:

  • 检查名称要和 必需的状态检查上下文 完全一样,大小写也要一致。YAML 里写 checkContext: ci,这里就填 ci。
  • 流水线还没开始,或者根本没有触发时,这项检查会显示为进行中,说明是「等待CI/CD流水线执行」,拉取请求不能合并。所以填进去的名字,一定要对应一条真的会被这个拉取请求触发的流水线。
  • 打开 需要状态检查通过,但 必需的状态检查上下文 留空时,这条规则不会拦住任何合并。

仓库 设置 → 拉取请求 里也有一个 需要状态检查 开关,说明是「合并前必须通过所有状态检查」。目前合并时起作用的是分支保护里的这一项,以分支保护为准配置。

5. 流水线红了,怎么变绿

检查还没变绿时,先分清是代码没过、偶发失败,还是任务还在等运行器(Runner,装在构建机上、实际执行任务的程序)。

你看到的情况 原因 怎么做
检查状态为 失败,测试或编译没过 代码本身有问题 在源分支上修改、提交、推送,自动触发新一次运行
偶发失败,例如下载依赖时网络抖动 外部环境抖动 打开那次最新运行,点 重跑
一直停在 进行中 任务在等待运行器 打开那次运行,看任务旁边的等待原因
状态检查里根本没有 ci 这一行 流水线未建立、未启用,或 branches 未包含目标分支 到 CI/CD → 流水线 确认流水线已启用,并核对 triggers 下的目标分支

重跑 只在最新的那次运行上用。已经推送了新提交之后,再去重跑一次旧提交的运行,旧提交的结果可能覆盖掉当前的检查状态。

常见问题

评审和流水线都要求通过,顺序有要求吗?

没有。两者是同时进行、分别判断的。评审人可以在流水线还在跑的时候开始看代码;合并时,评审条件和状态检查都满足才能合并。

同一个仓库有好几条流水线,都会显示在状态检查里吗?

会。每条被这个拉取请求触发的流水线,按各自的 checkContext 或名称显示为一行。只有填进 必需的状态检查上下文 的那几项,会被分支保护强制要求;不过网页上的合并按钮会要求所有已显示的检查都是成功。

草稿拉取请求也跑流水线,会不会浪费资源?

会多占一些运行器时间。好处是作者在转为可评审之前,就能先看到流水线结果。同一个提交只跑一次,所以草稿跑过之后,标记为可评审 时通常不会再跑一遍。

小结

让拉取请求自动跑流水线,在 YAML 的 triggers 里加 on: pull_request,branches 写目标分支,顶层用 checkContext 给检查起个固定的名字。发起拉取请求、推送新提交、重新打开都会触发,结果显示在 状态检查 里,详细日志到 CI/CD → 流水线 → 运行记录 里看。网页上只要有一项检查不是成功就合并不了;要让规则对接口和管理员也生效,在分支保护里打开 需要状态检查通过,填上同样的检查名称,并打开 对管理员同样生效。

结论: 在流水线 YAML 中配置 on: pull_request(branches 填目标分支)与 checkContext: ci,并在 main 的分支保护里打开 需要状态检查通过、填入 ci 且开启 对管理员同样生效,即可强制流水线通过后才允许合入。

参考文章

Top comments (0)