version

Documentation

Overview

Package version provides utilities for reporting build information (including version, build id, and status) for mixer.

Index

• type BuildInfo
  • func (b BuildInfo) String() string

Types

type BuildInfo

type BuildInfo struct {
	// Version is the tagged build version taken from SCM information.
	// Typically, this is from a `git describe` command.
	Version string

	// ID is a generated build ID. For mixer, by convention, we use:
	// YYYY-MM-DD-SHA, where SHA is the short SHA extracted from SCM
	// (typically, `git rev-parse --short HEAD`).
	ID string

	// Status is used to indicate if the build was done against a clean
	// checkout at the ID specified, or if there were local file
	// modifications. Typically, this should either be `Clean` or `Modified`.
	Status string
}

BuildInfo holds build-related information for Mixer.

var Info BuildInfo

Info is used to export the build info values set at runtime via `-ldflags`.

func (BuildInfo) String

func (b BuildInfo) String() string