go-flags

在Golang中，build过程主要由go build执行。它完成了源码的编译与可执行文件的生成。本文介绍如何在build过程中将git版本信息注入到程序中。

在编写go项目的Makefile时,看到可以通过链接选项来传入信息.

GITHASH := $(shell git rev-parse --short HEAD)
LDFLAGS += -X "main.ReleaseVersion=$(shell git tag  --contains)"
LDFLAGS += -X "main.BuildTS=$(shell date -u '+%Y-%m-%d %I:%M:%S')"
LDFLAGS += -X "main.GitHash=$(GITHASH)"
LDFLAGS += -X "main.GolangVersion=$(shell go version)"
LDFLAGS += -X "main.GitLog=$(shell git log --abbrev-commit --oneline -n 1 | sed 's/$(GITHASH)//g')"
LDFLAGS += -X "main.GitBranch=$(shell git rev-parse --abbrev-ref HEAD)"

all: build

build:
	go build -ldflags '$(LDFLAGS)'

通过-X importpath.name=value方式可以将在包路径为importpath中,名为name的字符串变量设置成值value. 但这当变量在源代码中未被初始化或者初始化为一个字符串字面量时才有效.

package main

var (
	BuildTS = ""
	GolangVersion string
)

func main(){
    fmt.Println("BuildTS: " + BuildTS) //将会打印build的时间
    fmt.Println("GolangVersion: " + GolangVersion) //将会打印使用的golang版本
}

参考文献:

1. https://golang.org/cmd/link/
2. https://ms2008.github.io/2018/10/08/golang-build-version/