GitHub Actions PR工作流中获取新增/修改JSON文件路径遇问题

问题根源 #

在PR触发的GitHub Actions工作流里，默认的actions/checkout是浅克隆状态（仅拉取最新一个提交），没有完整的提交历史，所以HEAD~1这个引用根本不存在，直接调用就会触发报错。

可行解决方案 #

1. 拉取完整仓库历史 #

修改Workflow里的checkout步骤，添加fetch-depth: 0参数，让动作拉取完整的提交历史：

steps:
  - name: 拉取代码
    uses: actions/checkout@v4
    with:
      fetch-depth: 0  # 拉取所有提交历史

之后就能正常使用HEAD~1，但这种方式会增加拉取时间，适合仓库体积不大的场景。

2. 针对PR场景用精准的对比范围 #

PR场景下，直接用GitHub提供的环境变量获取PR的基准分支和头部分支的提交哈希，对比逻辑更准确：
在你的script.sh里替换git命令：

# 获取PR中新增/修改的JSON文件路径
git diff --name-only --diff-filter=AM ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} | grep '\.json$'

如果坚持使用git diff-tree：

git diff-tree --no-commit-id --name-only -r ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} | grep '\.json$'

这种方式无需拉取完整历史，效率更高，也完全贴合PR场景的需求。

3. 浅克隆下的折中方案 #

如果不想拉取完整历史，可以在checkout后单独拉取基准分支的内容：

steps:
  - name: 拉取PR分支代码
    uses: actions/checkout@v4
    with:
      fetch-depth: 1
      ref: ${{ github.head_ref }}
  - name: 拉取基准分支
    run: git fetch origin ${{ github.base_ref }}:${{ github.base_ref }}

然后在脚本里对比基准分支和当前HEAD：

git diff --name-only --diff-filter=AM ${{ github.base_ref }} HEAD | grep '\.json$'

额外提示 #

• 确保Workflow的触发事件是pull_request，否则无法获取github.event.pull_request相关的环境变量
• --diff-filter=AM用来筛选新增（A）和修改（M）的文件，需要其他类型可调整参数（比如D代表删除）
• grep '\.json$'用于过滤出JSON文件，确保只处理目标文件类型

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