GitHub Actions：PR评论触发后如何检出PR源分支？

核心原因 #

通过issue_comment事件触发的工作流，默认不会自动关联PR的源分支上下文，直接使用actions/checkout@v3会克隆仓库默认分支（比如master），且无法直接获取PR对应的SHA值。

具体解决步骤 #

1. 先获取PR的源分支与SHA信息 #

借助GitHub CLI从事件文件中提取PR编号，再拉取PR的源分支名和对应SHA：

- name: 获取PR源分支信息
  id: get_pr_details
  run: |
    # 从事件文件中提取PR编号
    PR_NUMBER=$(jq --raw-output .issue.number "$GITHUB_EVENT_PATH")
    # 拉取PR的源分支和SHA信息
    PR_DATA=$(gh pr view $PR_NUMBER --json headRefName,headSha)
    # 将信息存入输出变量供后续步骤使用
    echo "branch=$(echo $PR_DATA | jq --raw-output .headRefName)" >> $GITHUB_OUTPUT
    echo "sha=$(echo $PR_DATA | jq --raw-output .headSha)" >> $GITHUB_OUTPUT
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

2. 检出PR的源分支 #

修改actions/checkout@v3的参数，指定ref为上一步获取的SHA值（用SHA比分支名更可靠，避免分支后续被修改）：

- name: 检出PR源分支
  uses: actions/checkout@v3
  with:
    ref: ${{ steps.get_pr_details.outputs.sha }}
    fetch-depth: 0 # 若需要完整提交历史，保留此参数；否则可删除以加快克隆速度

完整工作流示例 #

name: PR评论触发任务
on:
  issue_comment:
    types: [created]

jobs:
  process_pr_task:
    runs-on: ubuntu-latest
    # 仅在PR评论包含指定内容时触发
    if: contains(github.event.comment.body, '/some_comment') && github.event.issue.pull_request
    steps:
      - name: 获取PR源分支信息
        id: get_pr_details
        run: |
          PR_NUMBER=$(jq --raw-output .issue.number "$GITHUB_EVENT_PATH")
          PR_DATA=$(gh pr view $PR_NUMBER --json headRefName,headSha)
          echo "branch=$(echo $PR_DATA | jq --raw-output .headRefName)" >> $GITHUB_OUTPUT
          echo "sha=$(echo $PR_DATA | jq --raw-output .headSha)" >> $GITHUB_OUTPUT
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: 检出PR源分支
        uses: actions/checkout@v3
        with:
          ref: ${{ steps.get_pr_details.outputs.sha }}
          fetch-depth: 0

      # 在这里添加你的后续任务步骤

注意点 #

• 触发条件中必须加入github.event.issue.pull_request，避免非PR的普通issue评论触发工作流。
• GITHUB_TOKEN默认拥有获取PR信息的权限，无需额外配置。

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