如何让GitHub Actions工作流在PR评论时更新Pull Request检查状态？

可以通过issue_comment事件直接修改PR的检查状态，但需要解决PR关联信息获取和权限配置两个核心问题，以下是具体实现方案：

核心要点 #

1. 判断事件关联对象：issue_comment事件会触发在普通Issue和PR上，需要先过滤仅处理PR的评论（PR本质是带代码的Issue，可通过github.event.issue.pull_request判断）。
2. 获取PR的提交SHA：修改检查状态需要关联PR的head_sha（即PR最新提交的哈希值），必须从PR详情中获取。
3. 配置必要权限：需要给Action分配checks: write权限，用于修改检查状态；pull-requests: read权限用于读取PR标签、评论等信息。

完整Workflow配置示例 #

name: Github PR Audit

on:
  pull_request:
    types: [opened, edited, labeled, unlabeled]
  issue_comment:
    types: [created, edited, deleted]

# 配置Action所需权限
permissions:
  checks: write
  pull-requests: read

jobs:
  Audit-Pull-Request:
    runs-on: ubuntu-latest
    # 仅处理PR相关事件：PR自身事件或PR的评论事件
    if: |
      (github.event_name == 'pull_request') || 
      (github.event_name == 'issue_comment' && github.event.issue.pull_request)
    steps:
      - name: 执行PR合规检查并更新状态
        uses: actions/github-script@v7
        with:
          script: |
            // 获取PR编号：区分pull_request和issue_comment事件的不同上下文
            const prNumber = context.payload.issue?.number || context.payload.pull_request.number;
            
            // 获取PR完整信息
            const pr = await github.rest.pulls.get({
              owner: context.repo.owner,
              repo: context.repo.repo,
              pull_number: prNumber
            });
            
            // 检查PR标签是否符合要求
            const hasNoReleaseNotes = pr.data.labels.some(label => label.name === 'no release notes');
            const hasPublicReleaseNotes = pr.data.labels.some(label => label.name === 'public release notes');
            
            let checkStatus = 'success';
            let checkDesc = 'PR合规检查通过';
            
            // 标签合规性判断
            if (!hasNoReleaseNotes && !hasPublicReleaseNotes) {
              checkStatus = 'failure';
              checkDesc = '必须添加「no release notes」或「public release notes」标签';
            } 
            // 带public标签时检查发布说明评论
            else if (hasPublicReleaseNotes) {
              const comments = await github.rest.issues.listComments({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: prNumber
              });
              
              // 自定义发布说明格式判断规则：比如评论包含指定标题
              const hasValidNotes = comments.data.some(comment => 
                comment.body.includes('### 发布说明') || comment.body.includes('### Release Notes')
              );
              
              if (!hasValidNotes) {
                checkStatus = 'failure';
                checkDesc = '带有「public release notes」标签时，需添加格式规范的发布说明评论';
              }
            }
            
            // 更新PR的检查状态
            await github.rest.checks.create({
              owner: context.repo.owner,
              repo: context.repo.repo,
              name: 'PR合规检查',
              head_sha: pr.data.head.sha,
              status: 'completed',
              conclusion: checkStatus,
              output: {
                title: 'PR合规检查结果',
                summary: checkDesc
              }
            });

关键细节说明 #

• 权限配置：permissions字段必须显式设置，默认权限可能不足以修改检查状态。
• SHA关联：检查状态是绑定到PR的提交哈希的，必须使用pr.data.head.sha，不能用事件上下文里的其他SHA值。
• 格式判断规则：可以根据实际需求修改hasValidNotes的判断逻辑，比如匹配更严格的Markdown格式或关键词。

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