如何在GitHub Actions中关联PR与Issue？（限指定工具）

方案一：使用GitHub CLI（gh） #

这种方式简洁直接，适合熟悉命令行操作的场景，核心是用gh pr edit命令添加关联的Issue。

工作流示例 #

jobs:
  auto-link-pr-issue:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
      issues: write
    steps:
      - name: 检出代码
        uses: actions/checkout@v4

      # 你的现有PR创建步骤，这里示例用gh创建并提取PR编号
      - name: 创建Pull Request
        id: create_pr
        run: |
          # 替换为你的分支、标题和描述
          PR_URL=$(gh pr create --base main --head feature/fix-bug --title "修复问题" --body "详细描述")
          # 从PR链接中提取编号
          PR_NUMBER=$(echo "$PR_URL" | awk -F '/' '{print $7}')
          echo "pr_number=$PR_NUMBER" >> "$GITHUB_OUTPUT"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      # 关联PR与指定Issue
      - name: 关联PR到Issue
        run: |
          # 这里可以动态获取Issue编号，比如从分支名提取
          ISSUE_NUMBER=$(echo "${GITHUB_HEAD_REF}" | grep -oE '[0-9]+' | head -n1)
          gh pr edit ${{ steps.create_pr.outputs.pr_number }} --add-linked-issue "$ISSUE_NUMBER"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

关键说明 #

• 必须配置足够的权限：pull-requests: write和issues: write是关联操作的必要权限
• Issue编号可以动态获取：比如从分支名（如issue-123）提取，或者通过环境变量传入
• gh命令已预装在GitHub托管的runner中，无需额外安装

方案二：使用actions/github-script调用Octokit #

这种方式更灵活，适合需要复杂逻辑的场景，直接调用GitHub官方API实现关联。

工作流示例 #

jobs:
  auto-link-pr-issue:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
      issues: write
    steps:
      - name: 检出代码
        uses: actions/checkout@v4

      # 你的现有PR创建步骤，提取PR编号
      - name: 创建Pull Request
        id: create_pr
        run: |
          PR_URL=$(gh pr create --base main --head feature/fix-bug --title "修复问题" --body "详细描述")
          PR_NUMBER=$(echo "$PR_URL" | awk -F '/' '{print $7}')
          echo "pr_number=$PR_NUMBER" >> "$GITHUB_OUTPUT"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      # 通过Octokit API关联PR与Issue
      - name: 用Octokit关联PR到Issue
        uses: actions/github-script@v7
        with:
          script: |
            # 动态获取Issue编号（示例从分支名提取）
            const issueNumber = context.ref.match(/[0-9]+/)[0];
            await github.rest.issues.linkPullRequest({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: parseInt(issueNumber),
              pull_request_number: ${{ steps.create_pr.outputs.pr_number }}
            })

关键说明 #

• 使用的API是issues.linkPullRequest，专门用于关联PR到Issue，关联后会在Issue的Development板块显示该PR
• context变量是github-script内置的，可直接获取仓库、分支等信息
• 同样需要配置pull-requests: write和issues: write权限

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