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 versiondemo
go: 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 && ./main
version:  0.0.1

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

$ go build -o main --ldflags="-X 'main.version=client-0.0.2'" && ./main
version:  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 HEAD
154d0e19b63567fe85f713fd441f3f6a82a7aa7d

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

$ git rev-parse --short HEAD
154d0e1

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

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

Makefile学习

VERSION = $$(git describe --abbrev=0 --tags)
COMMIT_TAG = $$(git tag --points-at HEAD)
VERSION_DATE = $$(git log -1 --pretty='%ad' --date=format:'%Y-%m-%d' $(VERSION))
COMMIT_REV = $$(git rev-list -n 1 $(VERSION))
MAINTAINER = "Memory"

all: build

build:
    go build -ldflags "-X config/config.version=$(VERSION)" -o bin/doGo main.go && upx bin/doGo

mac
    env GOARCH=amd64 go build -ldflags "-s -w -X config/config.version=$(VERSION)" -o bin/macos/doGo && upx bin/macos/doGo

linux
    env GOOS=linux GOARCH=amd64 go build -ldflags "-s -w -X config/config.version=$(VERSION)" -o bin/linux/doGo && upx bin/linux/doGo

docker-build:
    docker build --build-arg VERSION=$(VERSION) --build-arg MAINTAINER=$(MAINTAINER) -t memory/doGo .

标签: Go

相关文章

一些编程语言学习心得

作为一名专注于PHP、Go、Java和前端开发(JavaScript、HTML、CSS)的开发者,还得会运维、会谈客户....不想了,都是泪,今天说说这些年学习编程语言的一些体会,不同编程语言在...

使用Go+ Wails开发轻量级桌面应用端

Wails 是一个使用 Go 语言开发的框架,允许开发者使用 Go 和前端技术(如 HTML、CSS 和 JavaScript)来构建跨平台的桌面应用程序。Wails 提供了一个简单的方式来将 ...

在 Go 项目中使用 LevelDB 进行数据存储

LevelDB 是一个由 Google 开发的高性能键值存储库,广泛应用于需要快速读写操作的场景。本文将介绍如何在 Go 项目中使用 LevelDB 作为数据存储,并通过示例代码展示如何初始化数...

详解Go语言依赖注入工具wire最佳实践介绍与使用

wire是一个强大的依赖注入工具,通过代码生成的方式实现了高效的依赖注入。本文详细介绍了wire的入门级和高级使用技巧,并通过示例代码展示了其强大的功能。无论是简单的依赖注入,还是复杂的依赖图生...

Go语言中copy命令讲解 切片之间复制元素

在Go语言中,copy函数是一个非常常用的内置函数,用于在切片(slice)之间复制元素。理解copy函数的用法和机制对于高效处理数据操作至关重要1. copy函数的基本用法copy函数的基本语...

深入理解 Go 语言中的 goto:用法与最佳实践

在学习编程语言时,goto 一直是一个颇具争议的概念。它常常因为“跳跃式”的行为被认为会让代码混乱且难以维护,但在 Go 语言中,goto 被保留并提供了一些实际的应用场景。今天我们将深入探讨 ...

图片Base64编码

CSR生成

图片无损放大

图片占位符

Excel拆分文件