version

Documentation

Overview

Package version contains all build time metadata (version, build time, git commit, etc).

Index

• func IsUpdateAvailable() (bool, string, error)
• type Version
  • func FromBuild() Version
  • func (v Version) IsProductionBuild() bool

Functions

func IsUpdateAvailable

func IsUpdateAvailable() (bool, string, error)

IsUpdateAvailable indicates if there is a newer application version available, and if so, what the new version is.

Types

type Version

type Version struct {
	Version           string `json:"version"`           // application semantic version
	JSONSchemaVersion string `json:"jsonSchemaVersion"` // application semantic JSON schema version
	GitCommit         string `json:"gitCommit"`         // git SHA at build-time
	GitDescription    string `json:"gitDescription"`    // output of 'git describe --dirty --always --tags'
	BuildDate         string `json:"buildDate"`         // date of the build
	GoVersion         string `json:"goVersion"`         // go runtime version at build-time
	Compiler          string `json:"compiler"`          // compiler used at build-time
	Platform          string `json:"platform"`          // GOOS and GOARCH at build-time
}

Version defines the application version details (generally from build information)

func FromBuild

func FromBuild() Version

FromBuild provides all version details

func (Version) IsProductionBuild

func (v Version) IsProductionBuild() bool