如何让deployment_status触发的工作流成为GitHub PR必填检查项？

可以实现，关键在于正确关联部署与Pull Request（PR），并配置工作流和分支保护规则，具体步骤如下：

1. 配置工作流触发条件 #

在GitHub Actions工作流文件（比如.github/workflows/deployment-check.yml）中，设置触发事件为deployment_status，并指定需要响应的状态类型：

on:
  deployment_status:
    types: [success] # 可根据需求添加failure、error等其他状态

2. 创建部署时关联PR #

调用Deployments API创建部署时，必须确保部署与目标PR关联：

• 设置ref参数为PR的目标分支（比如PR指向的主分支，或是PR自身的特征分支）
• 在payload字段中传入PR的编号等信息，示例请求体：

{
  "ref": "feature-branch",
  "environment": "production",
  "payload": {
    "pull_request_number": 123
  }
}

这样GitHub就能将部署状态变更事件与对应的PR关联起来，触发的工作流会自动出现在PR的Checks列表中。

3. 配置工作流权限 #

确保工作流拥有足够权限更新PR的检查状态，在工作流文件中添加权限配置：

permissions:
  statuses: write

4. 设置为PR必填检查项 #

1. 进入仓库的「Settings」→「Branches」页面
2. 找到目标分支的保护规则（若无则新建）
3. 在「Require status checks to pass before merging」选项中，勾选你创建的部署状态工作流名称
4. 保存规则后，该工作流的运行结果就会成为PR合并的必填条件

常见问题排查 #

• 如果工作流未出现在PR Checks中：检查部署是否确实关联了目标PR的分支，或查看Actions页面确认工作流是否被成功触发
• 如果无法设置为必填项：确保工作流至少成功运行过一次，GitHub才会在分支保护规则的可选检查列表中显示它

内容的提问来源于stack exchange，提问作者Patrick