手动触发的GitHub Actions工作流XYZ结果无法关联PR导致无法合并

问题根源 #

手动触发的GitHub Actions工作流默认不会关联到具体Pull Request的提交SHA，因此即使执行成功，其结果也不会被合并保护的状态检查规则识别，导致无法满足合并条件。

实现步骤 #

我们可以通过给手动触发添加PR编号输入参数+主动提交状态检查结果到PR对应提交的方式解决，同时保留原有的触发规则限制：

1. 修改工作流触发配置
   在workflow_dispatch中添加PR编号输入项，让用户手动触发时指定要关联的PR：

   on:
     pull_request:
       types: [opened]
     workflow_dispatch:
       inputs:
         pr_number:
           description: '要关联的Pull Request编号'
           required: true
           type: number
   

2. 添加工作流权限配置
   确保工作流拥有提交状态检查的权限，在工作流文件顶部添加：

   permissions:
     contents: read
     pull-requests: read
     statuses: write # 关键权限：用于提交状态检查结果
   

3. 获取PR对应的HEAD提交SHA
   通过GitHub API自动获取PR的最新提交SHA，区分PR触发和手动触发两种场景：

   jobs:
     xyz-job:
       runs-on: ubuntu-latest
       steps:
         - name: 获取PR HEAD提交SHA
           id: get_pr_sha
           uses: actions/github-script@v7
           with:
             script: |
               let targetSha;
               if (context.eventName === 'pull_request') {
                 // PR创建触发时，直接从事件上下文获取SHA
                 targetSha = context.payload.pull_request.head.sha;
               } else {
                 // 手动触发时，通过输入的PR编号查询SHA
                 const prData = await github.rest.pulls.get({
                   owner: context.repo.owner,
                   repo: context.repo.repo,
                   pull_number: context.inputs.pr_number
                 });
                 targetSha = prData.data.head.sha;
               }
               core.setOutput('sha', targetSha);
   

4. 执行原有工作流逻辑
   在这里添加你原本的工作流步骤（比如构建、测试等），保持和之前一致即可。

5. 主动提交状态检查结果到PR
   工作流执行完成后，无论成功失败，都向GitHub提交状态检查结果，关联到目标SHA：

   - name: 提交状态检查结果
           if: always()
           uses: actions/github-script@v7
           with:
             script: |
               const checkStatus = ${{ job.status }} === 'success' ? 'success' : 'failure';
               await github.rest.repos.createStatus({
                 owner: context.repo.owner,
                 repo: context.repo.repo,
                 sha: '${{ steps.get_pr_sha.outputs.sha }}',
                 state: checkStatus,
                 context: '工作流XYZ', // 必须和合并保护中设置的状态检查名称完全一致
                 description: checkStatus === 'success' ? '工作流检查通过' : '工作流检查失败',
                 target_url: `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`
               });
   

关键注意点 #

• context字段必须和你在main分支合并保护中设置的状态检查名称完全匹配，否则无法被识别。
• 手动触发工作流时，必须正确输入目标PR的编号，否则无法关联到对应提交。
• 确保工作流的权限配置正确，statuses: write是提交状态检查的必要权限。

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