version

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 29, 2025 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

CPU architecture of the running binary.

View Source
var BuildHost string

BuildHost stores the hostname of the machine where the binary was built. Set via -ldflags "-X main.BuildHost=$(hostname)"

View Source
var BuildTime string

BuildTime stores the build timestamp in UTC. Set via -ldflags "-X main.BuildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ)"

View Source
var BuildUser string

BuildUser is the username of the person or system that initiated the build process. Set via -ldflags "-X main.BuildUser=$(whoami)"

Compiler that built the running binary.

View Source
var GitBranch string

GitBranch holds the name of the Git branch from which the build was created. Set via -ldflags "-X main.GitBranch=$(git rev-parse --abbrev-ref HEAD)"

View Source
var GitCommit string

GitCommit stores the latest Git commit hash. Set via -ldflags "-X main.GitCommit=$(git rev-parse HEAD)"

View Source
var GitState string

GitState indicates whether the working directory was "clean" or "dirty" (i.e., with uncommitted changes). Set via -ldflags "-X main.GitState=$(if git diff-index --quiet HEAD --; then echo 'clean'; else echo 'dirty'; fi)"

View Source
var GitTag string

GitTag represents the most recent Git tag at build time, if any. Set via -ldflags "-X main.GitTag=$(git describe --tags --abbrev=0)"

View Source
var GoVersion string

GoVersion captures the Go version used to build the binary. Typically, this can be obtained automatically with runtime.Version(), but you can set it manually. Set via -ldflags "-X main.GoVersion=$(go version | awk '{print $3}')"

OS the running binary was built for.

View Source
var Version string

Version indicates the version of the binary, such as a release number or semantic version. Set via -ldflags "-X main.Version=v1.0.0"

View Source
var VersionInfo = map[string]interface{}{
	"version":         Version,
	"tag":             GitTag,
	"commit":          GitCommit,
	"branch":          GitBranch,
	"state":           GitState,
	"build_timestamp": BuildTime,
	"build_host":      BuildHost,
	"build_user":      BuildUser,
	"go_version":      GoVersion,
	"arch":            Arch,
	"os":              Os,
}

VersionInfo is all of the fields above combined into a map to be logged.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL