gebn / go-stamp Goto Github PK

From a user perspective, it's annoying to have to write 3 import statements to use the library. Just have stamp.<Everything>.

This is a bit specific given go-stamp's involvement is retrieving a string, however it's a good use case.

bazelbuild/bazel#5002 (comment)

Stamp uses a combination of workspace_status_command and x_defs to substitute values of Go vars at link time. Unfortunately, there does not currently appear to be a way to add keys to the workspace status from Starlark, so this must be manually configured.

First, create an executable script with the following contents somewhere in your workspace, e.g. bin/workspace_status (if you already have a workspace status script, you just need to add the three echo lines to it):

...

As mentioned here.

Such that it isn't identified as +incompatible. Even though this is a Bazel project, it could still be used by people running go tool link -X manually.

This is more common, and allows integration with gopkg.in.

go version -m <1.18 binary>, also available via debug.BuildInfo so less ldflags required.

Backwards-compatibility be damned.

import “github.com/gebn/go-stamp”

.Summary()

.CodeSummary()
.Branch
.Commit
.Version // up to build info script to set this to whatever it likes - we are VCS agnostic. Git describe is the example.

.BuildSummary()
.User
.Hostname
.Time() // can the raw string representation be made private?

$(git remote get-url origin)

Ideally, people wanting to use the library would only have to write the go_repository rule - the library would take care of adding necessary keys to the workspace status. Volatile build variables are provided for free by Bazel, however the STABLE_GIT_ ones must be provided by us - we effectively need a way to append to bazel-out/stable-status.txt within Starlark.

https://stackoverflow.com/a/68101437