自动版本号生成:利用git describe与分支TagName自动标注软件版本

陌磊酱_1419

陌磊酱_1419

2026-07-17

964人浏览

原创

git describe生成的版本号带“g”前缀是因为它标识当前提交哈希(如g1a2b3c4),其中“g”是“git”的缩写,表示head不在任何tag上,而是其后某次提交;例如v1.2.0-3-g1a2b3c4表示最近tag为v1.2.0、之后3次提交、当前短哈希为1a2b3c4。

自动版本号生成:利用git describe与分支tagname自动标注软件版本

git describe 生成的版本号为什么带“g”前缀?

因为 git describe 默认用 git rev-parse --short HEAD 的哈希前缀(如 g1a2b3c4)标识“未打 Tag 的提交”,g 是 “git” 缩写,不是错误。它说明当前 HEAD 不在任何 Tag 提交上,而是之后的某次提交。

常见现象:v1.2.0-3-g1a2b3c4 表示:最近 Tag 是 v1.2.0,之后有 3 次提交,当前提交短哈希是 1a2b3c4。

  • 若想去掉 g,可用 --abbrev=0(但会丢失哈希信息,不推荐)
  • 若希望统一格式(比如 CI 中需稳定输出),建议保留 g,并在解析逻辑中兼容该前缀
  • 某些构建工具(如 setuptools-scm)默认接受这种格式,无需额外处理

如何让 git describe 优先匹配当前分支的 Tag?

git describe 默认只看所有可达 Tag,不区分分支。要限制到“当前分支可见的 Tag”,需配合 --contains 或更可靠的方式:先获取当前分支最新 Tag 的提交范围。

实操建议用:

git describe --tags --abbrev=7 --match "v[0-9]*" $(git merge-base origin/main HEAD) 2>/dev/null || git describe --tags --abbrev=7 --match "v[0-9]*"

但更稳妥的做法是:在 CI 中明确指定基础分支(如 main 或 release/*),然后:

Cnb Cool Git
Cnb Cool Git

CNB 云原生构建平台的 Git 操作技能,支持代码克隆、提交、推送、分支管理、Merge Request 管理、流水线触发与结果读取。初次使用需收集用户的 Git 用户名和邮箱。

下载
  • 用 git describe --tags --abbrev=7 --match "v[0-9]*" origin/main^{} 2>/dev/null 获取 origin/main 上最近 Tag
  • 再结合 git rev-list origin/main..HEAD --count 算偏移量,手动拼接(避免跨分支污染)
  • CI 脚本里别依赖本地 git describe 默认行为,显式指定参考点

Tag 名称不规范(如 missing “v” 前缀)导致 describe 失败怎么办?

git describe 默认只匹配带 v 前缀的 Tag(如 v1.2.0),遇到 1.2.0 或 release-1.2.0 会跳过,最终报错 fatal: No names found, cannot describe anything.

解决方式取决于你能否修改历史 Tag:

  • 能改:用 git tag -d 1.2.0 && git tag v1.2.0 1.2.0 && git push --delete origin 1.2.0 && git push origin v1.2.0
  • 不能改:加 --match 参数放宽匹配,例如 --match "*[0-9]" 或 --match "release-*"
  • CI 中建议统一约定 Tag 格式,并在 PR 检查阶段用脚本校验:git tag --list | grep -qE '^v[0-9]+\.[0-9]+\.[0-9]+$' || (echo "invalid tag format" >&2; exit 1)

Python/Makefile 中安全调用 git describe 生成 __version__

直接在 setup.py 或 __init__.py 里运行 git describe 很危险:源码分发(sdist/wheel)时 Git 目录通常不存在,会崩溃。

正确做法分两层:

  • 构建时(CI 或本地 python -m build):用 setuptools-scm,配置 pyproject.toml:
    [build-system]<br>requires = ["setuptools", "setuptools-scm"]<br>[project]<br>dynamic = ["version"]<br>[tool.setuptools-scm]<br>version-file = "_version.py"
  • 运行时(无 Git 环境):确保生成的 _version.py 被打包进去,且含 fallback 版本(如 0.0.0+unknown)
  • Makefile 示例(避免 Python 依赖):
    VERSION := $(shell git describe --tags --abbrev=7 --match "v*" 2>/dev/null || echo "0.0.0-dev")
    注意:必须用 := 而非 =,否则每次展开都重新执行命令

最容易被忽略的是:本地开发时 git describe 可能返回 dirty 状态(如 v1.2.0-dirty),但很多项目不处理这个后缀——它表示工作区有未提交变更,上线前务必检查 clean 状态。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

git

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

2023.07.05

5399

9

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

2023.07.06

1640

6

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

2023.07.24

954

5

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

3517

7

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

3201

6

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

0

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

0

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

0

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

0

26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 7.9万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.8万人学习