別の Go プロジェクトのバージョン番号管理ソリューション

バージョン情報の管理は、プロジェクト開発中に考慮する必要がある問題です。特に、さまざまな種類のオープン ソース ソフトウェアでは、重要な機能はバージョン番号に関連付けられている必要があります。バージョン番号により、ユーザーはプログラムがどのような機能を提供するかを知ることができます。

#では、プロジェクトにバージョン番号を追加するにはどうすればよいでしょうか?ソースコードや設定ファイルにバージョン番号を直接記述し、機能がアップグレードされるたびにバージョン番号を変更するというハードコーディングを行ったことがある人も多いはずです。この方法は明らかに実行可能ですが、エラーが発生しやすくなります。第一に、バージョンをリリースするときにバージョン番号の更新を忘れがちであること、第二に、複数の支店コードがマージされると混乱が生じる可能性があることです。

次は、別の管理計画を示します。

ldflags -X 変数転送

go リンカー リンカーは、バイナリ ファイルをアセンブルするためのツールです。go build コマンドを実行すると、次のことができます。 pass <span style="font-size: 15px;">--ldflags</span> フラグはリンカー パラメーターを設定します。リンカーのオプション パラメーターを表示するには、次のステートメントを使用します。

go build --ldflags="--help"

多くのパラメータがありますが、私たちが興味があるのは、<span style="font-size: 15px;">-X</span>

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

## です。 #-X<span style="font-size: 15px;"></span> パラメーターでは、変数値の変更に使用される 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
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 流程中，让整个过程变得更加丝滑。

以上が別の Go プロジェクトのバージョン番号管理ソリューションの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。