version

Documentation

Overview

Package version supplies version information collected at build time to apimachinery components.

Index

• Variables
• func SetDynamicVersion(dynamicVersion string) error
• func ValidateDynamicVersion(dynamicVersion string) error
• type Info
  • func Get() Info
  • func (info Info) String() string
  • func (info Info) Text() ([]byte, error)
  • func (info Info) ToJSON() string

Variables

var (
	// GitVersion is semantic version.
	GitVersion = "v0.0.0-main+$Format:%h$"
	// BuildDate in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ').
	BuildDate = "1970-01-01T00:00:00Z"
	// GitCommit sha1 from git, output of $(git rev-parse HEAD).
	GitCommit = "$Format:%H$"
	// GitTreeState state of git tree, either "clean" or "dirty".
	GitTreeState = ""
)

Functions

func SetDynamicVersion

func SetDynamicVersion(dynamicVersion string) error

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

func ValidateDynamicVersion(dynamicVersion string) error

ValidateDynamicVersion ensures the given version is non-empty, a valid semantic version, and matched the major/minor/patch version of the default gitVersion.

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 info as a human-friendly version string.

func (Info) Text

func (info Info) Text() ([]byte, error)

Text encodes the version information into UTF-8-encoded text and returns the result.

func (Info) ToJSON

func (info Info) ToJSON() string

ToJSON returns the JSON string of version information.