buildinfo

Documentation

Overview

Package buildinfo hosts build info variables populated via ldflags.

Index

• Constants
• Variables
• func IsDefaultVersion() bool
• type BuildInfo
  • func Info() BuildInfo
  • func (bi BuildInfo) String() string

Constants

const DefaultVersion = "v0.0.0-dev"

DefaultVersion is the default value for Version if not set via ldflags.

Variables

var (
	// Version is the build version. If not set at build time via
	// ldflags, Version takes the value of DefaultVersion.
	Version = DefaultVersion

	// Commit is the commit hash.
	Commit string

	// Timestamp is the timestamp of when the cli was built.
	Timestamp string
)

Functions

func IsDefaultVersion

func IsDefaultVersion() bool

IsDefaultVersion returns true if Version is empty or DefaultVersion.

Types

type BuildInfo

type BuildInfo struct {
	Version   string `json:"version"`
	Commit    string `json:"commit,omitempty"`
	Timestamp string `json:"timestamp,omitempty"`
}

BuildInfo encapsulates Version, Commit and Timestamp.

func Info

func Info() BuildInfo

Info returns BuildInfo.

func (BuildInfo) String

func (bi BuildInfo) String() string

String returns a string representation of BuildInfo.