app

Documentation

Index

• Variables
• func CreatePropsFromPflags() *types.ArtifactProperties
• func Execute()
• func NewFlagValue(flagType FlagType, defaultVal string) pflag.Value
• func ParseTypeFlag(typeStr string) (string, string, error)
• type FlagType
• type Info
  • func VersionInfo() Info
  • func (i *Info) JSONString() (string, error)
  • func (i *Info) String() string

Variables

var (
	// Output of "git describe". The prerequisite is that the branch should be
	// tagged using the correct versioning strategy.
	GitVersion string = "devel"
)

Base version information.

This is the fallback data used when version information from git is not provided via go ldflags (e.g. via Makefile).

Functions

func CreatePropsFromPflags

func CreatePropsFromPflags() *types.ArtifactProperties

func Execute

func Execute()

Execute runs the base CLI

func NewFlagValue

func NewFlagValue(flagType FlagType, defaultVal string) pflag.Value

NewFlagValue creates a new pflag.Value for the specified type with the specified default value. If a default value is not desired, pass "" for defaultVal.

func ParseTypeFlag

func ParseTypeFlag(typeStr string) (string, string, error)

TODO: add tests for this

Types

type FlagType

type FlagType string

type Info

type Info struct {
	GitVersion   string
	GitCommit    string
	GitTreeState string
	BuildDate    string
	GoVersion    string
	Compiler     string
	Platform     string
}

func VersionInfo

func VersionInfo() Info

func (*Info) JSONString

func (i *Info) JSONString() (string, error)

JSONString returns the JSON representation of the version info

func (*Info) String

func (i *Info) String() string

String returns the string representation of the version info