如何在Gitlab CI中为pre-commit指定--from-ref参数

你遇到的origin/HEAD无法识别的报错，本质是GitLab CI默认的代码拉取策略导致的两个问题：

1. 默认开启浅克隆，本地只保留当前分支的部分提交记录，没有远程其他分支的提交
2. 默认不会自动初始化origin/HEAD这个指向远程仓库默认分支的引用别名

以下是不同场景下--from-ref的正确取值方案：

要检查当前MR分支相对于目标分支的所有变更文件，直接使用GitLab CI内置的环境变量作为--from-ref的取值：

# 提前拉取目标分支的完整提交记录
git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
# 执行pre-commit检查
pre-commit run --from-ref=origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME --to-ref=HEAD

如果要检查当前分支相对于远程默认分支的所有变更，先手动初始化origin/HEAD引用再执行检查：

# 手动设置origin/HEAD指向远程默认分支
git remote set-head origin --auto
# 执行pre-commit检查
pre-commit run --from-ref=origin/HEAD --to-ref=HEAD

如果只需要检查当前提交相对于上一次提交的改动，--from-ref直接取HEAD~1即可：

pre-commit run --from-ref=HEAD~1 --to-ref=HEAD

为了避免出现提交记录不存在的报错，建议在你的.gitlab-ci.yml中调整Git拉取配置，关闭浅克隆：

variables:
  GIT_DEPTH: 0

如果执行命令时依旧提示路径和引用冲突，在命令末尾加上--分隔符即可：

pre-commit run --from-ref=你的起始引用 --to-ref=HEAD --

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