如何在CircleCI path-filtering作业中获取PR变基合并至main的基准提交SHA

当使用rebase and merge方式合并PR时，PR分支会被变基到main分支的最新提交上，此时默认配置里的base-revision: main会导致path-filtering只对比变基后的最后一个提交与main的差异，而非分支最初分叉的基准点。要解决这个问题，你可以通过Git命令获取分支与main的最近共同祖先SHA（也就是分叉点），将其作为path-filtering的基准。

具体配置修改 #

1. 首先确保checkout步骤拉取完整仓库历史，避免因历史过浅导致无法找到分叉点：

- checkout:
    fetch-depth: 0

2. 添加一个run步骤，用git merge-base命令获取分叉点SHA并注入环境变量：

- run:
    name: 获取分支与main的分叉点SHA
    command: echo "export FORK_POINT=$(git merge-base main HEAD)" >> $BASH_ENV

3. 修改path-filtering/set-parameters的base-revision参数为上面获取的分叉点：

- path-filtering/set-parameters:
    base-revision: $FORK_POINT
    mapping: |
        # 你的路径映射规则
        src/... run-build-job=true
        docs/... run-docs-job=true

完整的filter job配置示例：

jobs:
  filter:
    executor: cli/default
    steps:
      - checkout:
          fetch-depth: 0
      - run:
          name: 获取分支与main的分叉点SHA
          command: echo "export FORK_POINT=$(git merge-base main HEAD)" >> $BASH_ENV
      - path-filtering/set-parameters:
          base-revision: $FORK_POINT
          mapping: |
              ...

原理说明 #

git merge-base main HEAD会输出当前分支（HEAD）与main分支的最近共同祖先提交SHA，这个SHA就是PR分支最初从main分叉的基准点。将其作为base-revision后，path-filtering会对比这个分叉点到当前HEAD的所有提交变更，从而正确识别PR中所有涉及的路径变化，无论PR是用哪种合并方式处理的。

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