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

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
	GitCommit    string `json:"gitCommit"`    // git SHA at build-time
	GitTreeState string `json:"gitTreeState"` // indication of git tree (either "clean" or "dirty") at build-time
	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