version

Documentation

Index

• Variables
• func GitSHA(packPath string) (string, error)
• func HumanVersion() string

Variables

var (
	// GitCommit and GitDescribe are filled by the compiler using ldflags to
	// provide useful Git information.
	GitCommit   string
	GitDescribe string

	// Version is the semantic version number describing the current state of
	// NOM.
	Version = "0.0.1"

	// Prerelease designates whether the current version is within a prerelease
	// phase. Typically, this will be "dev" to signify a development cycle or a
	// release candidate phase such as alpha, beta, rc1, or such.
	Prerelease = "techpreview1"

	// Metadata allows us to provide additional metadata information to the
	// version identifier. This is typically used to identify enterprise builds
	// using the "ent" metadata string.
	Metadata = ""
)

Functions

func GitSHA

func GitSHA(packPath string) (string, error)

GitSHA gets the git sha of a pack by directory. Requires git to be installed, pathPath to exist, and for packPath to be part of a git repository.

func HumanVersion

func HumanVersion() string

HumanVersion composes the parts of the version in a way that's suitable for displaying to humans.