version

Documentation

Overview

Package version resolves build metadata for the running binary.

Version resolution is delegated to clive: an ldflag-injected version when the build sets one (mise run install, GoReleaser), falling back to debug.BuildInfo so `go install ...@latest` and plain `go build` binaries report a real version instead of "dev". Commit, build time, and dirtiness come from the VCS metadata Go embeds at build time — no ldflags needed. Branch and BuildBy are jira-specific ldflags that clive does not model.

Index

• Variables
• func BuildTime() string
• func Commit() string
• func Dirty() bool
• func String() string
• func Version() string

Variables

var (
	Branch  = "unknown"
	BuildBy = "unknown"
)

Linker-injected build metadata clive does not model. Set via -ldflags; "unknown" otherwise.

Functions

func BuildTime

func BuildTime() string

BuildTime returns the commit timestamp (RFC 3339) embedded by the build, or "unknown" when no VCS info is present.

func Commit

func Commit() string

Commit returns the short VCS revision the binary was built from, or "unknown" when the build embedded no VCS info.

func Dirty

func Dirty() bool

Dirty reports whether the binary was built from a tree with uncommitted changes.

func String

func String() string

String returns the one-line "version (commit)" summary.

func Version

func Version() string

Version returns the resolved version string (see the package comment for the resolution order). It falls back to "dev" when no source resolves — e.g. `go run`, which embeds neither ldflags nor VCS info — so the version envelope field is never empty.