如何使用 Git 的“describe”命令派生应用程序构建版本字符串？

Question

我想编写应用程序构建版本，该版本是从我所在的 Git 分支名称（构建时）以及分支分歧以来的提交次数自动派生的。我相信这对于我的 Git 存储库中的任何提交都是唯一的？分支名称是唯一的，并且提交沿着分支相互链接？如果当我标记提交时，我还可以让版本以该标记为前缀。

在某种程度上 git describe 做了我想要的，但它不包括我所在的分支名称，并且它包括缩写的提交 SHA-1 哈希，我认为我不需要它不向字符串的熵添加任何内容，并且可能是多余的（我在这里可能是错的，所以请纠正我）。

我有什么选择？我的思考方向正确吗？当我有关于软件开发的更重要的事情需要处理时，我只是有点厌倦了在版本中附加数字。

顺便说一句，我从来不会用一棵肮脏的工作树来建造。即，我总是在构建公开版本之前向存储库提交更改。

Answer 1

git describe --long 总是会输出这样的版本号：v1.2-10-gdeadbee，这意味着自 annotated 标记以来的第 10 次提交v1.2' 指向带有缩短的 SHA-1 'deadbee' 的提交。因此，您所要做的就是标记分支开始（分支的分支点），例如 <branch>-start。

需要使用缩写的提交 SHA-1 哈希来区分不明确的情况，因为“自标记‘x’以来的第 3 次提交”（例如）不能唯一区分提交；在存在非线性、分支开发的情况下，可能有多个提交符合上述描述。例如，在下面的 ASCII-art 图所示的情况下，两个标有 * 的提交都符合“自标记‘x’以来的第 3 次提交”描述。

          /-.---*---.-\                   
         /             \                  
.---x---.---.---*---.---M---.    <--- branch

_{请注意，在如上所示的“合并”情况下，您不能使用分支名称来区分具有相同描述的这两个提交。}

因此您要做的就是采用 git描述 --long 输出（这里使用 --long 选项是为了避免解析时出现歧义，请参阅 git 描述手册页) ，解析它，并自己添加当前分支信息（例如来自 git symbolic-ref HEAD，不是来自 pasing gitbranch 输出）。

Answer 2

这是我使用的：

echo "`git symbolic-ref HEAD 2> /dev/null | cut -b 12-`-`git log --pretty=format:\"%h\" -1`"

它产生类似的内容：

master-6de772e

正如亚里士多德所指出的，实际上 SHA-1 本身就足以提供明确的构建标签以及有关发展历史背景的完整信息。其他一切都是多余的，因为它们提供的任何信息都可以从 SHA-1 中计算或导出。然而，人们可能也喜欢立即显而易见的实际分支的补充上下文信息（或者，至少这个人喜欢），因此将分支名称嵌入到标签中。也出于这个原因（即立即人工解析信息），我的大多数项目还使用更长的构建身份“描述”，其中除了构建身份“标签之外，还包括构建所基于的提交的日期和时间” ' 上面给出。

Answer 3

正式版本应该有一个带有版本号的标签。
在这种情况下，我建议采用以下方法：

1. 如果当前提交有标签，则使用该标签
2. 如果没有可用标签，则使用分支名称和 SHA1 密钥

此单个命令应该有效：

git describe --exact-match 2> /dev/null || echo "`git symbolic-ref HEAD 2> /dev/null | cut -b 12-`-`git log --pretty=format:\"%h\" -1`"

Answer 4

关于 git，您需要了解的是，分支本质上只是提交书签。当您进行 0deadbeef 提交时，您位于 foo 分支上这一事实对于提交本身来说并不重要；分支机构不是其身份的一部分。

（Mercurial 将分支名称烘焙到提交中。 正如达斯汀·塞林斯 (Dustin Sallings) 所解释的那样，从很多方面来说，这都是较差的。）

即使假设 gitdescribe 只会使用当前签出的分支 - 如果您有合并历史记录，则可能会有是通向 git describe 将使用的相同最新标记提交的多个路径。所以甚至不一定有任何一个分支。

另请注意：您可能会反对，即使“来自标签 X 的第三次提交”在一般情况下是不明确的，gitdescribe 也可以只查看图表并找出它是否是 不明确，如果不明确，则省略散列。但是，没有什么可以阻止任何人稍后在该标记之上启动分支 - 因此您的 describe 字符串将变得不明确。回顾。

最重要的是，提交的唯一明确标识符是它的哈希值。所以那一定是在那里。 gitdescribe 所做的是添加一些冗余（并且在提交编号的情况下不明确）信息，使描述对于人类的空间/关系理解更有用在 Git 模型的范围内定位自己。