version

Documentation

Index

• func GetVersionDetailsHuman() [][]string
• func GetVersionShort() string
• func IsDev() bool
• func NewSubCmd() *cobra.Command
• type VersionData
  • func GetVersion() VersionData
  • func (v VersionData) Fields() log.Fields

Functions

func GetVersionDetailsHuman

func GetVersionDetailsHuman() [][]string

GetVersionDetails provides an ordered list of version info fields

func GetVersionShort

func GetVersionShort() string

GetVersionShort returns a simple, short form of the fsoc version

func IsDev

func IsDev() bool

func NewSubCmd

func NewSubCmd() *cobra.Command

Types

type VersionData

type VersionData struct {
	Version           string `yaml:"version" json:"version" human:"Version"`
	VersionMajor      uint   `yaml:"major" json:"major"`
	VersionMinor      uint   `yaml:"minor" json:"minor"`
	VersionPatch      uint   `yaml:"patch" json:"patch"`
	VersionPrerelease string `yaml:"prerelease" json:"prerelease"`
	VersionMeta       string `yaml:"metadata" json:"metadata"`
	IsDev             bool   `yaml:"dev" json:"dev" human:"Dev Build"`
	GitHash           string `yaml:"git_hash" json:"git_hash" human:"Git Hash"`
	GitBranch         string `yaml:"git_branch" json:"git_branch" human:"Git Branch"`
	GitDirty          bool   `yaml:"git_dirty" json:"git_dirty" human:"Git Dirty"`
	GitTimestamp      uint64 `yaml:"git_timestamp" json:"git_timestamp" human:"Git Timestamp"`
	BuildTimestamp    uint64 `yaml:"build_timestamp" json:"build_timestamp" human:"Build Timestamp"`
	BuildHost         string `yaml:"build_host" json:"build_host" human:"Build Host"`
	Platform          string `yaml:"platform" json:"platform" human:"Platform"`
}

func GetVersion

func GetVersion() VersionData

GetVersion returns a copy of the fsoc version details

func (VersionData) Fields

func (v VersionData) Fields() log.Fields

Fields builds the structure required by the apex/log to log the version detail fields as part of a log message