version

package
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Apr 19, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package version exposes build / VCS / runtime metadata.

Two sources are honoured, in order of priority:

  1. Explicit ldflags injection (typical for tagged binaries built by goreleaser / Makefile):

    go build -ldflags " -X github.com/zynthara/chok/version.version=v1.0.0 -X github.com/zynthara/chok/version.gitHash=abc1234 -X github.com/zynthara/chok/version.buildTime=2024-01-01T00:00:00Z"

  2. Go's debug.ReadBuildInfo (Go 1.18+) — populated automatically for any binary built from a module, including those installed via `go install github.com/.../cmd/chok@latest`. Provides vcs.revision (git hash), vcs.time (build time from commit), vcs.modified (dirty flag), and main.Version (the @-suffix in `go install path@v1.2.3`).

The ldflags path always wins because release builds need an explicit, human-curated semver tag. ReadBuildInfo is the fallback that makes `go install ...@latest` show meaningful values instead of "dev / unknown / unknown".

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Info

type Info struct {
	Version   string `json:"version"`
	GitHash   string `json:"git_hash"`
	BuildTime string `json:"build_time"`
	GoVersion string `json:"go_version"`
	Modified  bool   `json:"modified,omitempty"`
}

func Get

func Get() Info

Get returns the active build metadata. Values set via ldflags take precedence; missing fields fall back to debug.ReadBuildInfo so that `go install ...@latest` and `go run` still produce useful output.

func (Info) String

func (i Info) String() string

String renders Info in a single line suited to startup logs and `chok version` output. Appends "+dirty" when the build came from a modified working tree, unless the Version already encodes the dirty marker. Both forms are recognised: Go pseudo-versions use "+dirty" (e.g. v0.1.1-0.20260419-abcd+dirty) while `git describe --dirty` uses "-dirty" (e.g. v0.1.0-75-g39917e8-dirty).

Jump to

Keyboard shortcuts

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