version

Documentation

Index

• func Channel() string
• func ChartVersion() string
• func Commit() string
• func IsEdgeChannel() bool
• func Release() string
• func ReportVersionHandler(w http.ResponseWriter, req *http.Request)
• func Version() string
• type VersionInfo
  • func NewVersionInfo() VersionInfo

Functions

func Channel

func Channel() string

Channel returns the designated channel for downloads of assets.

For a real release this will be the major.minor - for any other build it's the same as Release().

func ChartVersion

func ChartVersion() string

ChartVersion returns the version of the Helm Chart to be used by Kubernetes, Dev, and potentially Azure environments

func Commit

func Commit() string

Commit returns the full git SHA of the build.

This should only be used for informational purposes.

func IsEdgeChannel

func IsEdgeChannel() bool

IsEdgeChannel returns true if the channel is equal to "edge" and false otherwise.

func Release

func Release() string

Release returns the semver release version of the build.

This should only be used for informational purposes.

func ReportVersionHandler

func ReportVersionHandler(w http.ResponseWriter, req *http.Request)

ReportVersionHandler is the http server handler to report the radius version. It returns a JSON representation of the version info of the application when called. It returns a 500 status code if an error occurs.

func Version

func Version() string

Version returns the 'git describe' output of the build.

This should only be used for informational purposes.

Types

type VersionInfo

type VersionInfo struct {
	Channel      string `json:"channel"`
	Commit       string `json:"commit"`
	Release      string `json:"release"`
	Version      string `json:"version"`
	Bicep        string `json:"bicep"`
	ChartVersion string `json:"chartVersion"`
}

VersionInfo is used for a serializable representation of our versioning info.

func NewVersionInfo

func NewVersionInfo() VersionInfo

NewVersionInfo creates a new VersionInfo object with the current version information.