version

Documentation

Index

• Constants
• Variables
• func ForEachKindVersion(wrkDir string, kind VersionKind, callback Callback) error
• func ForEachVersion(wrkDir string, callback Callback) error
• func GetSemverVersion() (semver.Version, error)
• func GetVersion() string
• func LoadStableVersionNumber(wrkDir string, kind VersionKind, name string) (string, error)
• func SaveStableVersion(wrkDir string, kind VersionKind, name string, stableVersion *StableVersion) error
• func SaveStableVersionFile(path string, stableVersion *StableVersion) error
• func VersionStringDefault(defaultValue string) string
• type Callback
• type StableVersion
  • func LoadStableVersion(wrkDir string, kind VersionKind, name string) (*StableVersion, error)
  • func LoadStableVersionFile(path string) (*StableVersion, error)
  • func LoadStableVersionFromData(data []byte) (*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 (
	// Kinds all the version kinds
	Kinds = []VersionKind{
		KindChart,
		KindPackage,
		KindDocker,
	}
	// KindStrings all the kinds as strings for validating CLI arguments
	KindStrings = []string{
		string(KindChart),
		string(KindPackage),
		string(KindDocker),
	}
)

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 ForEachKindVersion

func ForEachKindVersion(wrkDir string, kind VersionKind, callback Callback) error

ForEachKindVersion processes all of the versions in the wrkDir and kind using the given callback function.

func ForEachVersion

func ForEachVersion(wrkDir string, callback Callback) error

ForEachVersion processes all of the versions in the wrkDir using the given callback function.

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 SaveStableVersion

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

SaveStableVersion saves the version file

func SaveStableVersionFile

func SaveStableVersionFile(path string, stableVersion *StableVersion) error

SaveStableVersionFile saves the stabe version to the given file 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 Callback

type Callback func(kind VersionKind, name string, version *StableVersion) (bool, error)

Callback a callback function for processing version information. Return true to continue processing or false to terminate the loop

type StableVersion

type StableVersion struct {
	Version string `json:"version,omitempty"`
	GitURL  string `json:"gitUrl,omitempty"`
	URL     string `json:"url,omitempty"`
}

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

func LoadStableVersionFile

func LoadStableVersionFile(path string) (*StableVersion, error)

LoadStableVersionFile loads the stable version data from the given file name

func LoadStableVersionFromData

func LoadStableVersionFromData(data []byte) (*StableVersion, error)

LoadStableVersionFromData loads the stable version data from the given the data

type VersionKind

type VersionKind string

VersionKind represents the kind of version

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

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

	// KindDocker represents a docker image version
	KindDocker VersionKind = "docker"
)