version

Documentation

Index

• Variables
• type Info
  • func Get() Info
  • func (i Info) String() string
  • func (i Info) Text() ([]byte, error)
  • func (i Info) ToJSON() string

Variables

var (
	// Version is the current version of application.
	Version = "v0.0.0-master+$Format:%h$"

	// GitCommit sha1 from git, output of $(git rev-parse HEAD).
	GitCommit = "$Format:%H$"

	// GitTreeState state of git tree, either "clean" or "dirty".
	GitTreeState string

	// BuildTime in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ').
	BuildTime = "1970-01-01T00:00:00Z"
)

Base version information.

Types

type Info

type Info struct {
	Version      string `json:"version"`
	GitCommit    string `json:"gitCommit"`
	GitTreeState string `json:"gitTreeState"`
	BuildTime    string `json:"buildTime"`
	GoVersion    string `json:"goVersion"`
	Compiler     string `json:"compiler"`
	Platform     string `json:"platform"`
}

func Get

func Get() Info

Get returns the overall codebase version. It's for detecting what code a binary was built from.

func (Info) String

func (i Info) String() string

String returns info as a human-friendly version string.

func (Info) Text

func (i Info) Text() ([]byte, error)

Text encodes the version information into UTF-8-encoded text and returns the result.

func (Info) ToJSON

func (i Info) ToJSON() string

ToJSON returns the JSON string of version information.