version

Documentation

Index

• Constants
• Variables
• func GetSemverVersion() (semver.Version, error)
• func GetVersion() string
• func LoadStableVersionNumber(wrkDir string, kind VersionKind, name string) (string, error)
• func VersionStringDefault(defaultValue string) string
• type StableVersion
  • func LoadStableVersion(wrkDir string, kind VersionKind, name string) (*StableVersion, error)
• type VersionKind

Constants

const (
	// VersionPrefix string for setting pre-release etc
	VersionPrefix = ""

	// ExampleVersion shows an example version in the help
	// if no version could be found (which should never really happen!)
	ExampleVersion = "1.1.59"

	// TestVersion used in test cases for the current version if no
	// version can be found - such as if the version property is not properly
	// included in the go test flags
	TestVersion = "1.0.1"
)

Variables

var (
	Version   string
	Revision  string
	Branch    string
	BuildUser string
	BuildDate string
	GoVersion string
)

Build information. Populated at build-time.

var Map = map[string]string{
	"version":   Version,
	"revision":  Revision,
	"branch":    Branch,
	"buildUser": BuildUser,
	"buildDate": BuildDate,
	"goVersion": GoVersion,
}

Map provides the iterable version information.

Functions

func GetSemverVersion

func GetSemverVersion() (semver.Version, error)

GetSemverVersion returns a semver.Version struct representing the current version

func GetVersion

func GetVersion() string

GetVersion gets the current version string

func LoadStableVersionNumber

func LoadStableVersionNumber(wrkDir string, kind VersionKind, name string) (string, error)

LoadStableVersionNumber loads just the stable version number for the given kind and name

func VersionStringDefault

func VersionStringDefault(defaultValue string) string

VersionStringDefault returns the current version string or returns a dummy default value if there is an error

Types

type StableVersion

type StableVersion struct {
	Version string
	GitURL  string
	URL     string
}

StableVersion stores the stable version information

func LoadStableVersion

func LoadStableVersion(wrkDir string, kind VersionKind, name string) (*StableVersion, error)

LoadStableVersion loads the stable version data from the version configuration directory returning an empty object if there is no specific stable version configuration available

type VersionKind

type VersionKind string

VersionKind represents the kind of version

var (
	// KindChart represents a chart version
	KindChart VersionKind = "charts"

	// KindPackage represents a package version
	KindPackage VersionKind = "packages"
)