Git 工作流中的 幂等设计 最佳实践
从一次“重试就炸”说起
前阵子给一个仓库写自动发版脚本,本地跑得好好的,放到 CI 里一重试就出问题:tag 已经存在,release 也建过了,脚本卡在最后一步,日志红得挺均匀。说实话,Git 里很多命令你手敲的时候没感觉,一进脚本、一加重试,幂等问题就露出来了。
幂等这事听起来像分布式系统里的词,其实在 Git 工作流里特别朴素:同一个操作执行一次和执行三次,最终状态应该一样,至少不能多出三个重复提交、三个同名标签,或者三次重复通知。下面这些是我现在写脚本时会刻意处理的点。
先分清哪些操作天生不幂等
git fetch、git push 相同内容、git checkout 基本是安全的,重复跑结果差不多。但 git commit 每次都会生成新提交,git tag 重复创建会直接报错,git merge 可能产生新的合并提交,git rebase 会改写历史。还有 gh release create、发评论、发通知这类外部副作用,重复执行最容易翻车。
所以写自动化脚本时,我会先把动作分成两类:一类是“确保状态存在”,一类是“创建新东西”。前者要尽量写成可重复执行,后者要么加检查,要么加锁。
提交之前先看有没有东西可提交
最典型的就是定时任务里无脑 git add -A && git commit。没变更的时候也会失败,或者产生空提交。现在我会先判断暂存区:
git add -A
if git diff --cached --quiet; then
echo "没有变更,跳过提交"
else
git commit -m "$1"
fi
这段放进函数里重复调用也没问题。注意 git diff --cached --quiet 在有差异时返回 1,所以别在 set -e 下直接裸写,放在 if 里比较稳。
合并和变基要能识别“已经做过了”
自动同步主分支时,我会先判断当前分支是不是已经包含目标分支:
git fetch origin main
if git merge-base --is-ancestor origin/main HEAD; then
echo "已经包含 origin/main,跳过合并"
else
git merge --no-edit origin/main
fi
这样重复跑不会反复产生合并提交。但要注意,如果上一次合并停在冲突状态,下一次重试不能假装没事。脚本里最好先检查 .git/MERGE_HEAD,有就退出并保留现场,别硬来。rebase 也一样,先看 .git/rebase-merge 或 .git/rebase-apply 是否存在。worktree 里 .git 可能是个文件,路径别照抄。
标签和发布:把“创建”改成“确保存在”
打标签是重灾区。git tag -a v1.2.3 第二次执行直接报 already exists。我一般会先查本地,再查远程:
TAG="v1.2.3"
if git rev-parse --verify --quiet "$TAG" >/dev/null; then
echo "本地 tag 已存在"
else
git tag -a "$TAG" -m "$TAG"
fi
if git ls-remote --tags origin "refs/tags/$TAG" | grep -q .; then
echo "远程 tag 已存在"
else
git push origin "refs/tags/$TAG"
fi
发布也类似,用 gh 的话可以先 gh release view,存在就上传附件并加 --clobber,不存在才创建:
if gh release view "$TAG" >/dev/null 2>&1; then
gh release upload "$TAG" dist/* --clobber
else
gh release create "$TAG" dist/* --title "$TAG" --notes-file CHANGELOG.md
fi
这样脚本重跑不会多出一个 release,附件也能覆盖成最新产物。
CI 和钩子里别留“半截状态”
Git 钩子和 CI 脚本最怕跑到一半失败,下一次重试又从头来。我的习惯是:写操作前先检查工作区干不干净,冲突状态直接退出,不要自动 reset --hard 把别人的东西抹了。需要串行的地方用 CI 的 concurrency,或者本地用 flock 加个锁。清理未跟踪文件这种危险动作,先 git clean -nd 看一眼,别直接 -fd。
最后
我现在写这类脚本,基本会先把“创建”改成“确保存在”,把“直接执行”改成“先判断状态”。幂等不是让 Git 历史永远不变,而是让重复执行变得安全:该跳过的跳过,该覆盖的覆盖,该停下的停下。这样失败之后还能放心重试,不用靠人手抖着去删标签、删分支、删 release。
评论
还没有评论。
发表评论
提交后评论将经过自动审核,审核通过后公开展示。