Git仓库中硬编码版本号最优实现及version.txt未跟踪问题解决

嘿，我来帮你解决当前的痛点，顺便给你梳理个更简洁可靠的替代方案——毕竟用pre/post-commit钩子维护version.txt确实有点繁琐，还容易出问题。

先解决你当前的钩子问题：为什么version.txt总是未跟踪？ #

你的post-commit脚本里，先执行了git rm -q version.txt删除了已跟踪的文件，然后重新生成了新的version.txt，但这个新文件没有被加入Git暂存区，所以每次commit后它就变成了未跟踪状态。

如果非要修复这个钩子逻辑，你可以在post-commit的最后加上git add version.txt，但这里要注意：post-commit钩子不能直接执行git commit（会触发钩子循环），所以这个修改会一直留在暂存区，每次git status都会显示有未提交的更改，这其实挺干扰开发流程的。

所以，我更推荐你换掉这个钩子方案，用下面两种更简单的方式：

方案一：发布时手动生成version.txt（适合小型项目） #

这个方案完全不用钩子，核心思路是用Git标签管理正式版本，发布时把版本号写入version.txt并提交到仓库：

1. 每次发布新版本时，先打一个语义化标签，比如：

   git tag v1.2.3
   git push origin v1.2.3
   

2. 然后生成version.txt并提交：

   git describe --tags --always > version.txt
   git add version.txt
   git commit -m "更新version.txt到v1.2.3"
   git push
   

3. 最后在你的启动脚本里，优先读取version.txt的内容，如果文件不存在（比如用户克隆仓库后误删，或者用了旧版本），再尝试用git describe作为 fallback：

   # 读取版本号逻辑
   if [ -f "version.txt" ]; then
       VERSION=$(cat version.txt)
   elif command -v git >/dev/null 2>&1 && [ -d ".git" ]; then
       VERSION=$(git describe --tags --always)
   else
       VERSION="unknown"
   fi
   echo "当前版本：$VERSION"
   

这个方案的好处：

• 直接下载的用户能拿到仓库里的version.txt，看到准确的版本号
• 克隆仓库的用户即使没有version.txt，也能通过Git获取版本号
• 完全不用维护复杂的钩子，避免了钩子失效、版本号计算错误等问题

方案二：用GitHub Actions自动生成version.txt（适合自动化发布） #

如果你的项目用GitHub托管，可以用Actions实现打标签自动更新version.txt，全程不用手动操作：

1. 在仓库根目录创建.github/workflows/update-version.yml文件：

   name: 打标签时自动更新version.txt
   on:
     push:
       tags:
         - 'v*' # 只响应v开头的标签
   
   jobs:
     update-version:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v4
           with:
             fetch-depth: 0 # 必须拉取所有历史，才能获取标签信息
         - name: 生成version.txt
           run: git describe --tags --always > version.txt
         - name: 提交并推送修改
           run: |
             git config --global user.name "GitHub Actions Bot"
             git config --global user.email "actions@github.com"
             git add version.txt
             git commit -m "自动更新version.txt到标签${{ github.ref_name }}"
             git push
   

2. 以后每次打标签并推送，Actions就会自动生成version.txt并提交到仓库，直接下载的用户就能拿到最新的版本号了。

为什么你的钩子方案不太靠谱？ #

你的pre-commit钩子在commit前把version.txt改成下一个版本并add，post-commit又改回当前的git describe版本，但改回后没有add，所以变成未跟踪。就算你在post-commit里add了，也会导致git status一直有未提交的更改，干扰正常开发。而且这种钩子逻辑太绕，很容易因为钩子没生效、awk命令解析错误等问题导致版本号出错。

总结下来，用标签+发布时生成version.txt的方案是最简洁可靠的，既满足了直接下载用户的需求，也不依赖Git环境，还能避免钩子带来的各种麻烦～

内容的提问来源于stack exchange，提问作者Samuel K.