How to Embed Git Revision Information in Go Binaries for Troubleshooting?

Determining Git Revision in Go Binaries

When deploying code, it can be helpful to associate binaries with the git revision they were built from for troubleshooting purposes. However, directly updating the source code with the revision number is not feasible, as it alters the source.

Solution: Utilize Build Flags

A solution to this challenge involves leveraging build flags. By setting the version variable in the main package with the current git revision using build flags, you can maintain a link between binaries and their source versions. This can be achieved through the following steps:

1. Obtain the git revision into a $VERSION environment variable using the command git rev-parse --short HEAD.
2. Set the version variable in the main package with the build flag -ldflags "-X main.version=$VERSION" during the go build process.

Here's an example script that demonstrates this approach:

#!/bin/sh
VERSION=`git rev-parse --short HEAD`
go build -ldflags "-X main.version=$VERSION"  myfile.go

By executing this script, you can build binaries with the current git revision embedded in the version variable, allowing you to retrieve it later using ./mybinary --revision.

The above is the detailed content of How to Embed Git Revision Information in Go Binaries for Troubleshooting?. For more information, please follow other related articles on the PHP Chinese website!