version

Documentation

Index

• Variables
• func PrintVersionInfo()
• func VersionInfo() string

Variables

var BuildHost string

BuildHost stores the hostname of the machine where the binary was built. Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.BuildHost=$(hostname)"

var BuildTime string

BuildTime stores the build timestamp in UTC. Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.BuildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ)"

var BuildUser string

BuildUser is the username of the person or system that initiated the build process. Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.BuildUser=$(whoami)"

var GitBranch string

GitBranch holds the name of the Git branch from which the build was created. Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.GitBranch=$(git rev-parse --abbrev-ref HEAD)"

var GitCommit string

GitCommit stores the latest Git commit hash. Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.GitCommit=$(git rev-parse HEAD)"

var GitState string

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

var GitTag string

GitTag represents the most recent Git tag at build time, if any. Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.GitTag=$(git describe --tags --abbrev=0)"

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 github.com/OpenCHAMI/magellan/internal/version.GoVersion=$(go version | awk '{print $3}')"

var Version string

Version indicates the version of the binary, such as a release number or semantic version. Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.Version=v1.0.0"

Functions

func PrintVersionInfo

func PrintVersionInfo()

PrintVersionInfo outputs all versioning information for troubleshooting or version checks.

func VersionInfo

func VersionInfo() string