build

Documentation

Overview

Package build contains information about the build that injected at build-time.

To use this package, simply import it in your program, then add build arguments like the following:

go build -ldflags "-X github.com/onflow/flow-go/cmd/build.semver=v1.0.0"

Index

• Variables
• func Commit() string
• func IsDefined(v string) bool
• func Semver() (*smv.Version, error)
• func Version() string

Variables

var UndefinedVersionError = fmt.Errorf("version is undefined")

Functions

func Commit

func Commit() string

Commit returns the commit at which this build was created.

func IsDefined

func IsDefined(v string) bool

IsDefined determines whether a version string is defined. Inputs should have been produced from this package.

func Semver

func Semver() (*smv.Version, error)

Semver returns the semantic version of this build as a semver.Version if it is defined, or UndefinedVersionError otherwise. The version string is converted to a semver compliant one if it isn't already but this might fail if the version string is still not semver compliant. In that case, an error is returned.

func Version

func Version() string

Version returns the raw version string of this build.