go build编译时给程序注入commit hash和编译时间

[xpzouying]

在做CI/CD时，常常希望把build的时间和commit hash信息注入到我们的程序中。当我们运行main -v时，就可以显示我们对应的版本信息。

类似于这样，

./main -v
build time: 20210217
build commit_id: d5bb263

[xpzouying]

实现

Go的代码

package main

import (
	"flag"
	"fmt"
)

var (
	VersionCmd   bool
	BuildVersion = "unknown"
	BuildTime    = "unknown"
)

func main() {
	flag.BoolVar(&VersionCmd, "v", false, "show version")
	flag.Parse()

	if VersionCmd {
		fmt.Printf("build time: %s\nbuild commit_id: %s\n", BuildTime, BuildVersion)

		return
	}

	fmt.Println("hello world")
}

Makefile

在go build编译时，注入相关的信息。

BUILDTIME=$(shell date '+%Y%m%d')
COMMIT_ID=$(shell git rev-parse --short HEAD)

build:
	CGO_ENABLED=0 go build -ldflags '-X "main.BuildTime=$(BUILDTIME)"  \
		    -X "main.BuildVersion=$(COMMIT_ID)" '

说明

go build -ldflags加入-X将对应package中的变量进行赋值。在上面的示例中有，

• main.BuildTime - 设置为当前时间
• main.BuildVersion - 设置为hash id

这里都是设置main package中的变量，也可以指定其他package的变量，例如：
github.com/xpzouying/some/package.Version

源码参考：

• https://github.com/xpzouying/learning_golang/tree/master/go_build_inject_commit_id