使用GitHub Actions和github-script@v4自动变基时遇错误求助

问题背景 #

需要通过GitHub Actions实现dev分支的所有开放PR自动变基，避免分支过时后手动更新。但使用自定义运行器执行脚本时，出现「无法找到git可执行文件」的错误。

现有YAML配置 #

name: Auto Rebase Branch

on:
  push:
    branches:
      - dev
  pull_request:
    branches:
      - dev
    types: [opened, synchronize, reopened, closed]

permissions:
  contents: write
  pull-requests: write

concurrency:
  group: 'auto-rebase-${{ github.ref }}'
  cancel-in-progress: true

jobs:
  auto-rebase:
    runs-on:
      group: custom-runner-here
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Rebase all open PRs
        uses: actions/github-script@v4
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            const baseBranch = 'dev';

            async function rebasePR(pr) {
              const headBranch = pr.head.ref;

              try {
                console.log(`Rebasing ${headBranch} on top of ${baseBranch}`);

                // Checkout the PR branch
                await exec.exec(`git checkout ${headBranch}`);

                // Perform the rebase operation
                await exec.exec(`git rebase ${baseBranch}`);

                // Force-push the rebased branch
                await exec.exec(`git push origin ${headBranch} --force`);

                console.log(`Successfully rebased ${headBranch} onto ${baseBranch}`);
              } catch (error) {
                console.error('Error during rebase:', error.message);
                core.setFailed(`Rebase of ${headBranch} failed. Please resolve conflicts manually.`);
              }
            }

            async function main() {
              // Get all open pull requests for the base branch
              let page = 1;
              let hasMore = true;

              while (hasMore) {
                const { data: pullRequests } = await github.pulls.list({
                  owner: context.repo.owner,
                  repo: context.repo.repo,
                  state: 'open',
                  base: baseBranch,
                  per_page: 100,
                  page: page
                });

                if (pullRequests.length === 0) {
                  hasMore = false;
                }

                for (const pr of pullRequests) {
                  await rebasePR(pr);
                }

                page++;
              }
            }

            main();

错误日志 #

Run actions/github-script@v4
(node:116) [DEP0005] DeprecationWarning: Buffer() is deprecated due to security and usability issues. Please use the Buffer.alloc(), Buffer.allocUnsafe(), or Buffer.from() methods instead.

(Use `node --trace-deprecation ...` to show where the warning was created)
Rebasing test11 on top of dev

Error during rebase: Unable to locate executable file: git. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also check the file mode to verify the file is executable.
Error: Rebase of test11 failed. Please resolve conflicts manually.

Rebasing test5 on top of UA-1991-2nd-work-around
Error during rebase: Unable to locate executable file: git. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also check the file mode to verify the file is executable.
Error: Rebase of test5 failed. Please resolve conflicts manually.

解决步骤 #

1. 确认自定义运行器已安装Git #

登录到自定义运行器所在的机器，执行以下命令检查Git是否安装：

# Linux/macOS
git --version

# Windows (PowerShell)
git --version

如果未安装，根据操作系统安装Git：

• Linux：使用包管理器安装，例如Ubuntu执行sudo apt update && sudo apt install git -y
• Windows：通过Git官网下载安装程序，或用Chocolatey执行choco install git -y
• macOS：使用Homebrew执行brew install git，或通过Xcode Command Line Tools安装xcode-select --install

2. 确保Git路径在环境变量PATH中 #

确认Git的可执行文件路径已加入系统PATH：

# Linux/macOS查看Git路径
which git

# Windows查看Git路径
where git

如果Git路径不在PATH中，有两种解决方式：

• 永久添加：修改运行器机器的系统环境变量，将Git所在目录加入PATH
• 临时添加（Workflow中）：在Workflow的steps中添加一步，将Git路径加入GitHub Actions的PATH：

  - name: Add Git to PATH
    run: |
      # Linux/macOS示例
      echo "$(dirname $(which git))" >> $GITHUB_PATH
      # Windows示例（PowerShell）
      # $gitPath = (Get-Command git).Source | Split-Path -Parent
      # echo "$gitPath" | Out-File -FilePath $env:GITHUB_PATH -Append
  

3. 优化Workflow脚本（可选） #

在github-script中执行Git命令时，可以直接指定Git的绝对路径，避免PATH问题：

// 将git命令替换为绝对路径，例如Linux的/usr/bin/git
await exec.exec(`/usr/bin/git checkout ${headBranch}`);
await exec.exec(`/usr/bin/git rebase ${baseBranch}`);
await exec.exec(`/usr/bin/git push origin ${headBranch} --force`);

4. 其他优化建议 #

• 移除不必要的触发事件：pull_request的closed类型不需要触发自动变基，可从on.pull_request.types中删除
• 处理冲突场景：当前脚本遇到冲突会直接失败，可添加逻辑跳过有冲突的PR，或通知PR作者

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