version

Documentation

Index

• Variables
• func AddFlags(fs *pflag.FlagSet)
• func PrintAndExitIfRequested(appName string)
• type Info
  • func Get() Info
  • func (info Info) String() string
  • func (info Info) Text() ([]byte, error)

Variables

var (
	// GitVersion is semantic version.
	GitVersion = "v0.0.0-master+$Format:%h$"
	// BuildDate in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ')
	BuildDate = "1970-01-01T00:00:00Z"
	// GitCommit sha1 from git, output of $(git rev-parse HEAD)
	GitCommit = "$Format:%H$"
	// GitTreeState state of git tree, either "clean" or "dirty"
	GitTreeState = ""
)

Functions

func AddFlags

func AddFlags(fs *pflag.FlagSet)

AddFlags registers this package's flags on arbitrary FlagSets, such that they point to the same value as the global flags.

func PrintAndExitIfRequested

func PrintAndExitIfRequested(appName string)

PrintAndExitIfRequested will check if the -version flag was passed and, if so, print the version and exit.

Types

type Info

type Info struct {
	GitVersion   string `json:"gitVersion"`
	GitCommit    string `json:"gitCommit"`
	GitTreeState string `json:"gitTreeState"`
	BuildDate    string `json:"buildDate"`
	GoVersion    string `json:"goVersion"`
	Compiler     string `json:"compiler"`
	Platform     string `json:"platform"`
}

Info contains versioning information.

func Get

func Get() Info

Get returns the overall codebase version. It's for detecting what code a binary was built from.

func (Info) String

func (info Info) String() string

BaseName returns info as a human-friendly version string.

func (Info) Text

func (info Info) Text() ([]byte, error)

Text encodes the version information into UTF-8-encoded text and returns the result.