version

Documentation

Index

• type Info
  • func Get() Info
  • func (info Info) String() string
• type ReleaseVersion
  • func ParseGitVersion(gitVersion string) (*ReleaseVersion, error)
  • func (r *ReleaseVersion) ReleaseVersion() string

Types

type Info

type Info struct {
	GitVersion   string `json:"gitVersion"`
	GitCommit    string `json:"gitCommit"`
	GitTreeState string `json:"gitTreeState"`
	BuildDate    string `json:"buildDate"`
	GoVersion    string `json:"goVersion"`
	Compiler     string `json:"compiler"`
	Platform     string `json:"platform"`
}

Info contains versioning information.

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 (info Info) String() string

String returns a Go-syntax representation of the Info.

type ReleaseVersion

type ReleaseVersion struct {
	*utilversion.Version
}

ReleaseVersion represents a released version.

func ParseGitVersion

func ParseGitVersion(gitVersion string) (*ReleaseVersion, error)

ParseGitVersion parses a git version string, such as: - v1.1.0-73-g7e6d4f69 - v1.1.0 - v1.1.0-alpha.1-3-gf20c721a

func (*ReleaseVersion) ReleaseVersion

func (r *ReleaseVersion) ReleaseVersion() string

ReleaseVersion returns the parsed version in the following format: - v1.2.1-12-g2eb92858 --> v1.2.1 - v1.2.3-12-g2e860210 --> v1.2.3 - v1.3.0-alpha.1-12-g2e860210 --> v1.3.0-alpha.1 It could be patch release or pre-release