README
¶
go-version
This package was originally extracted from
sigs.k8s.io/release-utils.
Since then, it has been changed quite a bit (see full list below).
Original license can be found in NOTICE.md.
Changes
Full list of changes from the original library:
- drop all dependencies:
- use std testing only
- allow to pass a previously generated ASCII art instead of generating it at runtime
- optional overrides:
- caller can pass one or more functions that change the version info, so callers are free to use whatever methods they want to provide some options
- a range of functions are provided by the library
- added more fields:
URLBuiltBy
- testing
- added more tests, hopefully preventing breaking changes in the future
Documentation
¶
Overview ¶
Package goversion provides utilities to get the Go module version information.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Info ¶
type Info struct {
GitVersion string `json:"gitVersion"`
ModuleSum string `json:"moduleChecksum"`
GitCommit string `json:"gitCommit"`
GitTreeState string `json:"gitTreeState"`
BuildDate string `json:"buildDate"`
BuiltBy string `json:"builtBy"`
GoVersion string `json:"goVersion"`
Compiler string `json:"compiler"`
Platform string `json:"platform"`
ASCIIName string `json:"-"`
Name string `json:"-"`
Description string `json:"-"`
URL string `json:"-"`
}
Info provides the version info.
func GetVersionInfo ¶
GetVersionInfo represents known information on how this binary was built.
func (*Info) JSONString ¶
JSONString returns the JSON representation of the version info
type Option ¶
type Option func(i *Info)
Option can be used to customize the version after its gathered from the environment.
func WithASCIIName ¶
WithASCIIName allows you to add an ASCII art of the name.
func WithAppDetails ¶
WithAppDetails allows to set the app name and description.
func WithBuiltBy ¶
WithBuiltBy allows to set the builder name/builder system name.
Source Files