Go 项目生成版本号

参考

• 在Golang代码中自动生成版本号的方式

• 一个不一样的 Go 项目版本号管理方案

版本号的作用

版本信息管理，是项目开发中需要考虑的问题。尤其在各类开源软件中，重要的功能特性一定需要版本号绑定。通过版本号，用户才能知道该程序提供了哪些功能。

那么，如何为项目添加版本号呢？很多人应该都使用过硬编码方式，即将版本号直接写入源码或者配置文件，每次功能升级就修改版本号。这种方式，显然是可行的，但是也容易出错。一是发版时，容易忘记更新版本号，二是多个分支代码合并时，也可能搞混。

下文，给大家带来一个不一样的管理方案。

ldflags -X 变量传递

go 链接器 Linker 是组装二进制文件的工具，我们在执行 go build 命令时，可以通过 --ldflags 标志设定链接器参数，使用以下语句可查看链接器可选参数。

go build --ldflags="--help"

参数很多，但我们感兴趣的是 -X

$ go build --ldflags="--help"usage: link [options] main.o...  -X definition     add string value definition of the form importpath.name=value...

-X 参数，指定 importpath.name=value，用于修改变量值。其中 importpath 表示包导入路径，name 是程序中的变量名，value 代表我们想要设定的变量值。

下面，我们通过示例项目来具体感受一下。

$ mkdir versionDemo $ cd versionDemo/$ go mod init versiondemogo: creating new go.mod: module versiondemo$ touch main.go

在 main 函数中，我们打印 version 值。

package main import ( "fmt") var ( version = "0.0.1") func main() { fmt.Println("version: ", version)}

如果正常编译执行程序，将得到以下结果

$ go build -o main && ./mainversion:  0.0.1

此时，我们指定 --ldflags 的 -X 参数重新编译执行

$ go build -o main --ldflags="-X 'main.version=client-0.0.2'" && ./mainversion:  client-0.0.2

可以看到 version 参数值已经被改变。

添加 git 信息

开发中需要使用 git 工具，本文讨论的版本管理，也经常与 git tag 挂钩。那其实有更酷的操作：我们可以在构建期间，通过 git commit 信息自动填充版本号。

我们基于上文项目目录，添加 git commit 信息。

$ git init$ git add .$ git commit -m "initial commit"

通过以下命令，可拿到 git commit 的 hash 值

$ git rev-parse HEAD46dab0ddb6ba20445c2c1f047575e25d3aad1a27

该值较长，我们可以添加 --short 选项获取短 hash 值。

$ git rev-parse --short HEAD46dab0d

此时，通过指定 --ldflags 的 -X 参数，将 version 值替换成 git commit 的哈希值。这样，我们成功地将项目版本与 git 信息绑定在了一起。

$ go build -o main --ldflags="-X 'main.version=$(git rev-parse --short HEAD)'" && ./mainversion:  46dab0d

总结

本文介绍了一种如何通过 ldflags -X 变量传递的方式。使用这种方式我们可以在构建时轻松设定一些元信息，例如本文示例的程序版本信息。而这种构建的动作不应该手动去执行，而是放入到 CI/CD 流程中，让整个过程变得更加丝滑。

关于 ldflags 的用例或版本号管理方案，如果大家有更好的想法，欢迎留言交流。