version

Documentation

Index

• Variables
• func IsDevelopment() bool
• func Semver() (semver.Version, error)
• func ShortString() string
• func String() string
• func Version() string

Variables

var ErrIsDevelopment = errors.New("this development binary has no semantic version")

ErrIsDevelopment is returned whenever functions are called that require a valid release version (generally, a valid semantic version) to parse.

Functions

func IsDevelopment

func IsDevelopment() bool

IsDevelopment returns true if the build type is not "release", and true otherwise. Note that checking whether the build type is "development" is not sufficient, because buildType may be empty when no ldflags are used.

func Semver

func Semver() (semver.Version, error)

Semver returns the build's parsed release version.

func ShortString

func ShortString() string

ShortString returns a machine-readable version string. If this is a release build, it returns the release version; otherwise, it returns the commit.

func String

func String() string

String returns a long, human-readable version string.

func Version

func Version() string

Version returns the version string as-is, even if empty.