Go:如何将git修订版添加到构建的二进制文件中？

Question

我想将当前的git修订版号添加到构建的二进制文件中,go build以便我可以做一些类似于./mybinary --revision查看它的构建版本的内容(通常用于稍后部署后的故障排除).显然,我不能将修订号放入源中,因为这将使用新修订更改源.我想知道是否有其他方法可以做到这一点？或者你认为这只是一个坏主意？如果是这样,建立二进制文件与其源版本之间关系的推荐方法是什么？对于分布式版本控制系统,版本号似乎不是一个好主意.

Answer 1

如果你可以将git修订版带入$ VERSION并version在主包中有一个名为(type string)的变量,你可以在构建期间使用以下命令设置它:

#!/bin/sh
VERSION=`git rev-parse --short HEAD`
go build -ldflags "-X main.version=$VERSION"  myfile.go

Answer 2

ldflags从 Go 1.18（2021 年第 4 季度/2022 年第 1 季度）开始，正常流程不应再涉及任何。

请参阅问题 37475和CL 356013

该go命令现在将版本控制信息嵌入到二进制文件中，包括当前签出的修订版本和指示是否存在已编辑或未跟踪文件的标志。

go如果在 Git 或 Mercurial 存储库内的目录中调用命令，并且main包及其包含main模块位于同一存储库中，则嵌入版本控制信息。
可以使用标志省略该信息-buildvcs=false。

此外，该go命令嵌入以下信息：

• 构建包括构建和工具标签（使用 进行设置-tags），
• 编译器，
• 汇编器，和
• 链接器标志（如-gcflags），
• 是否cgo启用，如果启用，则显示cgo环境变量的值（如CGO_CFLAGS）。

可以使用标志省略该信息-buildinfo=false。

VCS 和构建信息都可以与模块信息一起读取，使用：

• go version -m file或者
• runtime/debug.ReadBuildInfo（对于当前运行的二进制文件）或
• 新debug/buildinfo包。

CL 373875添加

• 该BuildInfo结构具有新字段，其中包含有关如何构建二进制文件的附加信息。
• 新GoVersion字段保存用于构建二进制文件的 Go 版本。
• 新字段是保存描述构建的键/值对的结构体Settings切片。BuildSettings