version

Documentation

Overview

Package version reports what build this is.

The values are injected at link time. A build without them reports "dev" rather than an empty string or a plausible-looking version: a binary that cannot say what it is should say so, not guess.

Index

• Constants
• Variables
• func IsRelease() bool
• func Short() string
• func String() string

Constants

const (
	SourceRelease = "release"
	SourceLocal   = "local"
)

The two origins that matter. Anything else is a build we cannot account for, and is treated as local — the cautious reading, since it is the one that refuses to overwrite.

Variables

var (
	Version = ""
	Commit  = ""
	Date    = ""
	// Source is how this binary was produced. Only the release pipeline sets
	// it to SourceRelease; every other path leaves it as it found it.
	//
	// It is a separate variable rather than a shape inferred from Version
	// because `update` refuses to overwrite a binary it did not publish, and a
	// decision like that should not rest on parsing a string that anyone can
	// pass on a command line.
	Source = ""
)

Injected via -ldflags at build time.

Functions

func IsRelease

func IsRelease() bool

IsRelease reports whether the release pipeline produced this binary.

func Short

func Short() string

Short returns the version alone.

func String

func String() string

String returns version, commit, date and platform.