buildinfo

Documentation

Overview

Package buildinfo hosts build info variables populated via ldflags.

For testing, you can override the build version using envar SQ_BUILD_VERSION (panics if not a valid semver).

Index

• Constants
• Variables
• func IsDefaultVersion() bool
• type Info
  • func Get() Info
  • func (bi Info) LogValue() slog.Value
  • func (bi Info) ShortCommit() string
  • func (bi Info) String() string
  • func (bi Info) UserAgent() string

Constants

const DefaultVersion = "v0.0.0-dev"

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

const EnvOverrideVersion = `SQ_BUILD_VERSION`

EnvOverrideVersion is used for testing build version, e.g. for config upgrades.

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 Info

type Info struct {
	Version   string    `json:"version" yaml:"version"`
	Commit    string    `json:"commit,omitempty" yaml:"commit,omitempty"`
	Timestamp time.Time `json:"timestamp,omitempty" yaml:"timestamp,omitempty"`
}

Info encapsulates Version, Commit and Timestamp.

func Get

func Get() Info

Get returns Info. If buildinfo.Timestamp cannot be parsed, the returned Info.Timestamp will be the zero value.

func (Info) LogValue

func (bi Info) LogValue() slog.Value

LogValue implements slog.LogValuer.

func (Info) ShortCommit

func (bi Info) ShortCommit() string

ShortCommit returns the short commit hash.

func (Info) String

func (bi Info) String() string

String returns a string representation of Info.

func (Info) UserAgent

func (bi Info) UserAgent() string

UserAgent returns a string suitable for use in an HTTP User-Agent header.