Documentation
¶
Overview ¶
Package version supplies version information collected at build time to apimachinery components.
Index ¶
- Constants
- func AddFlags(fs *flag.FlagSet)
- func PrintAndExitIfRequested(appName string)
- func SetDynamicVersion(dynamicVersion string) error
- func ValidateDynamicVersion(dynamicVersion string) error
- func Version(name string, value versionValue, usage string) *versionValue
- func VersionVar(p *versionValue, name string, value versionValue, usage string)
- type Info
Constants ¶
const ( VersionFalse versionValue = 0 VersionTrue versionValue = 1 VersionRaw versionValue = 2 )
Variables ¶
This section is empty.
Functions ¶
func AddFlags ¶
AddFlags registers this package's flags on arbitrary FlagSets, such that they point to the same value as the global flags.
func PrintAndExitIfRequested ¶
func PrintAndExitIfRequested(appName string)
PrintAndExitIfRequested will check if the -version flag was passed and, if so, print the version and exit.
func SetDynamicVersion ¶
SetDynamicVersion overrides the version returned as the GitVersion from Get(). The specified version must be non-empty, a valid semantic version, and must match the major/minor/patch version of the default gitVersion.
func ValidateDynamicVersion ¶
ValidateDynamicVersion ensures the given version is non-empty, a valid semantic version, and matched the major/minor/patch version of the default gitVersion.
func VersionVar ¶
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.
Source Files