如何优雅的在 Zadig 上实践交付物溯源流程

运行工作流，可以看到构建变量已经成功的透传，并且替换了预设的变量模板。

部署后查看控制台，可以看到 Zadig 的构建信息已经可以在 console 中显示。

由于后端二进制交付物背后的项目类型比较多，这里主要介绍 Golang 项目一种实现思路，该部分涉及到的源码可以点击链接[9]查看，其他项目类型可以根据实际情况进行参考和配置。

1. 定义版本信息

这里在项目中维护一份 version.go 文件，根据实际需求，定义需要暴露的参数。

package utilsimport (    "fmt"    "runtime")var (    version      string    gitBranch    string    gitTag       string    gitCommit    string    gitPR        string    gitTreeState string    buildDate    string    buildURL      string)// Info contains versioning information.type Info struct {    Version      string `json:"version"`    GitBranch    string `json:"gitBranch"`    GitTag       string `json:"gitTag"`    GitCommit    string `json:"gitCommit"`    GitPR        string `json:"gitPR"`    GitTreeState string `json:"gitTreeState"`    BuildDate    string `json:"buildDate"`    BuildURL     string `json:"buildURL"`    GoVersion    string `json:"goVersion"`    Compiler     string `json:"compiler"`    Platform     string `json:"platform"`}// String returns info as a human-friendly version string.func (info Info) String() string {    return info.Platform}func GetVersion() Info {    return Info{        Version:      version,        GitBranch:    gitBranch,        GitTag:       gitTag,        GitCommit:    gitCommit,        GitPR:        gitPR,        GitTreeState: gitTreeState,        BuildDate:    buildDate,        BuildURL:     buildURL,        GoVersion:    runtime.Version(),        Compiler:     runtime.Compiler,        Platform:     fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),    }}

2. main 函数调用

在入口处设置传入version参数调用GetVersion函数：

package mainimport (    "fmt"    "os"    "version/utils")func main() {    args := os.Args    if len(args) >= 2 && args[1] == "version" {        v := utils.GetVersion()        fmt.Printf("Version: %s\nBranch: %s\nCommit: %s\nPR: %s\nBuild Time: %s\nGo Version: %s\nOS/Arch: %s\nBuild URL: %s\n", v.Version, v.GitBranch, v.GitCommit,v.GitPR, v.BuildDate, v.GoVersion, v.Platform,v.BuildURL)    } else {        fmt.Printf("Version(hard code): %s\n", "0.1")    }}

3. 构建工程文件编写

这里新建一个 Makefile 进行构建，使用ldflags -X透传 Zadig 构建内置变量，核心逻辑如下：

# build with verison infosversinotallow="version/utils"gitTag=$(version_TAG)gitBranch=$(version_BRANCH)gitPR=$(version_PR)buildDate=$(shell TZ=Asia/Shanghai date +%FT%T%z)gitCommit=$(version_COMMIT_ID)gitTreeState=$(shell if git status|grep -q "clean";then echo clean; else echo dirty; fi)buildURL=$(BUILD_URL)ldflags="-s -w -X ${versionDir}.gitTag=${gitTag} -X ${versionDir}.buildDate=${buildDate} -X ${versionDir}.gitCommit=${gitCommit} -X ${versionDir}.gitPR=${gitPR} -X ${versionDir}.gitTreeState=${gitTreeState} -X ${versionDir}.versinotallow=${VERSION} -X ${versionDir}.gitBranch=${gitBranch} -X ${versionDir}.buildURL=${buildURL}"PACKAGES=`go list ./... | grep -v /vendor/`VETPACKAGES=`go list ./... | grep -v /vendor/ | grep -v /examples/`GOFILES=`find . -name "*.go" -type f -not -path "./vendor/*"`default:    @echo "build the ${BINARY}"    @GOOS=linux GOARCH=amd64 go build -ldflags ${ldflags} -o  build/${BINARY}.linux  -tags=jsoniter    @go build -ldflags ${ldflags} -o  build/${BINARY}.mac  -tags=jsoniter    @echo "build done."

在 Zadig 中配置构建，在构建脚本中构建并打印输出，详细信息如下：

set -ecd $WORKSPACE/zadig/examples/version-demoenvmake defaultcd build./version.linux version

运行工作流，可以看到构建变量已经成功的透传，并且该二进制程序通过version参数可以打印详细的构建来源信息。

以上，就是一些常见交付物类型在 Zadig 上的溯源思路总结，相比于通过原始的 Image ID 、Digest ....来反推进行追踪，该流程可以让用户以及开发人员通过更简单便捷的方式上报或者追踪交付物问题，提高问题排查定位的效率。

[1]https://docs.docker.com/config/labels-custom-metadata/

[2]https://github.com/opencontainers/image-spec/blob/main/annotations.md

[3]https://docs.docker.com/engine/reference/builder/#label

[4]https://docs.docker.com/engine/reference/builder/#arg

[5] https://github.com/koderover/zadig-portal/blob/main/Dockerfile

[6] https://webpack.js.org/plugins/define-plugin/

[7] https://webpack.js.org/plugins/environment-plugin/#root

[8]https://nodejs.org/api/process.html#process_process_env

[9]https://github.com/koderover/zadig/tree/main/examples/version-demo

[10] https://pkg.go.dev/cmd/link

[11]https://github.com/kubernetes/kubectl/blob/master/pkg/cmd/version/version.go

[12] https://github.com/kubernetes/component-base/blob/master/version/version.go

[13] https://zhuanlan.zhihu.com/p/150991555

标签：