如何通过GitHub Actions在PR分支提交并推送文件修改？

问题核心 #

当通过GitHub Actions处理向prd分支发起的PR时，在源分支（如test）生成文件后，执行常规git命令无法推送回原分支，主要原因是默认的Actions checkout仅提供只读权限，且未正确配置推送的目标分支与认证凭证。

解决方案步骤 #

1. 调整Checkout步骤的配置 #

确保checkout到PR的源分支，并禁用默认只读凭证，获取完整仓库历史：

- name: Checkout code
  uses: actions/checkout@v4
  with:
    persist-credentials: false  # 禁用默认只读凭证，避免后续推送权限冲突
    fetch-depth: 0  # 获取完整提交历史，防止提交时出现历史不一致问题
    ref: ${{ github.head_ref }}  # 切换到PR的源分支（而非目标分支prd）

2. 配置工作流权限 #

在工作流顶部添加权限声明，确保Actions拥有内容写入权限：

permissions:
  contents: write  # 赋予Actions修改仓库内容的权限

3. 修正git推送命令 #

原命令缺少分支指定与权限认证，替换为带凭证的完整推送命令，同时添加空提交检查避免报错：

git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add -A

# 检查是否有实际变更，避免空提交
if git diff --staged --quiet; then
  echo "No changes to commit"
  exit 0
fi

git commit -m "Auto-generated required files"
# 使用GITHUB_TOKEN作为认证，推送到PR的源分支
git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:${{ github.head_ref }}

完整工作流示例 #

name: Auto-generate Required Files on PR
on:
  pull_request:
    branches: [ prd ]

permissions:
  contents: write

jobs:
  generate-and-push:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout PR source branch
        uses: actions/checkout@v4
        with:
          persist-credentials: false
          fetch-depth: 0
          ref: ${{ github.head_ref }}

      - name: Set up Python environment
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Run file generation script
        run: python your_generator_script.py

      - name: Commit and push changes
        run: |
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"
          git add -A
          if git diff --staged --quiet; then
            echo "No changes detected, skipping commit"
            exit 0
          fi
          git commit -m "Added auto-generated required files"
          git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:${{ github.head_ref }}

关键注意事项 #

• ${{ github.head_ref }}：自动获取PR的源分支名称，无需手动指定分支名
• GITHUB_TOKEN：GitHub自动提供的内置令牌，已赋予仓库读写权限（需通过permissions声明开启）
• 空提交检查：避免因无文件变更导致工作流报错

内容的提问来源于stack exchange，提问作者Shreshth.K