那么,如何为项目添加版本号呢?很多人应该都使用过硬编码方式,即将版本号直接写入源码或者配置文件,每次功能升级就修改版本号。这种方式,显然是可行的,但是也容易出错。一是发版时,容易忘记更新版本号,二是多个分支代码合并时,也可能搞混。
下文,给大家带来一个不一样的管理方案。
go 链接器 Linker 是组装二进制文件的工具,我们在执行 go build 命令时,可以通过 <code style='font-size: 14px;overflow-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgba(14, 210, 247, 0.15);'><span style="font-size: 15px;">--ldflags</span>
--ldflags 标志设定链接器参数,使用以下语句可查看链接器可选参数。
go build --ldflags="--help"
参数很多,但我们感兴趣的是 <span style="font-size: 15px;">-X</span>
</p>-X<div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false;">$ go build --ldflags="--help"
usage: link [options] main.o
...
-X definition
add string value definition of the form importpath.name=value
...</pre><div class="contentsignin">登录后复制</div></div>
下面,我们通过示例项目来具体感受一下。 在 main 函数中,我们打印 version 值。 如果正常编译执行程序,将得到以下结果 此时,我们指定 --ldflags 的 -X 参数重新编译执行 可以看到 version 参数值已经被改变。 开发中需要使用 git 工具,本文讨论的版本管理,也经常与 git tag 挂钩。那其实有更酷的操作:我们可以在构建期间,通过 git commit 信息自动填充版本号。 我们基于上文项目目录,添加 git commit 信息。 通过以下命令,可拿到 git commit 的 hash 值 该值较长,我们可以添加 --short 选项获取短 hash 值。 此时,通过指定 --ldflags 的 -X 参数,将 version 值替换成 git commit 的哈希值。这样,我们成功地将项目版本与 git 信息绑定在了一起。 本文介绍了一种如何通过 ldflags -X 变量传递的方式。使用这种方式我们可以在构建时轻松设定一些元信息,例如本文示例的程序版本信息。而这种构建的动作不应该手动去执行,而是放入到 CI/CD 流程中,让整个过程变得更加丝滑。<span style="font-size: 15px;">-X</span>
</span>-X</p>
<🎜> 参数,指定 importpath.name=value,用于修改变量值。其中 importpath 表示包导入路径,name 是程序中的变量名,value 代表我们想要设定的变量值。<🎜><🎜>$ mkdir versionDemo
$ cd versionDemo/
$ go mod init versiondemo
go: creating new go.mod: module versiondemo
$ touch main.go
package main
import (
"fmt"
)
var (
version = "0.0.1"
)
func main() {
fmt.Println("version: ", version)
}
$ go build -o main && ./main
version: 0.0.1
$ go build -o main --ldflags="-X 'main.version=client-0.0.2'" && ./main
version: client-0.0.2
添加 git 信息
$ git init
$ git add .
$ git commit -m "initial commit"
$ git rev-parse HEAD
46dab0ddb6ba20445c2c1f047575e25d3aad1a27
$ git rev-parse --short HEAD
46dab0d
$ go build -o main --ldflags="-X 'main.version=$(git rev-parse --short HEAD)'" && ./main
version: 46dab0d
总结
以上是一个不一样的 Go 项目版本号管理方案的详细内容。更多信息请关注PHP中文网其他相关文章!