Eine andere Versionsnummernverwaltungslösung für Go-Projekte

Das Versionsinformationsmanagement ist ein Thema, das bei der Projektentwicklung berücksichtigt werden muss. Insbesondere bei verschiedenen Arten von Open-Source-Software müssen wichtige Funktionsmerkmale an Versionsnummern gebunden werden. Anhand der Versionsnummer können Benutzer erkennen, welche Funktionen das Programm bereitstellt.

Also, wie füge ich dem Projekt eine Versionsnummer hinzu? Viele Leute hätten Hardcodierung verwenden sollen, das heißt, die Versionsnummer direkt in den Quellcode oder die Konfigurationsdatei schreiben und die Versionsnummer jedes Mal ändern, wenn die Funktion aktualisiert wird. Diese Methode ist offensichtlich machbar, aber auch fehleranfällig. Erstens vergisst man leicht, die Versionsnummer zu aktualisieren, wenn man eine Version veröffentlicht. Zweitens kann es zu Verwirrung kommen, wenn mehrere Zweigstellencodes zusammengeführt werden.

Im Folgenden finden Sie einen anderen Managementplan.

ldflags – : 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);">--ldflags

Flags legen Linker-Parameter fest. Verwenden Sie die folgende Anweisung, um optionale Linker-Parameter anzuzeigen.

go build --ldflags="--help"

<span style="font-size: 15px;">--ldflags</span> 标志设定链接器参数，使用以下语句可查看链接器可选参数。

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

参数很多，但我们感兴趣的是 <span style="font-size: 15px;">-X</span>

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

<span style="font-size: 15px;">-X</span>Es gibt viele Parameter, aber die, die uns interessieren, sind

package main

import (
 "fmt"
)

var (
 version = "0.0.1"
)

func main() {
 fmt.Println("version: ", version)
}

Nach dem Login kopieren

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

$ 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
46dab0ddb6ba20445c2c1f047575e25d3aad1a27

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

$ git rev-parse --short HEAD
46dab0d

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

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

总结

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

Das obige ist der detaillierte Inhalt vonEine andere Versionsnummernverwaltungslösung für Go-Projekte. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!