version

Documentation

Index

• Constants
• func GetBuildInfo() (rev string, t time.Time, mod bool, err error)
• type Version
  • func New() (v Version)
  • func (v *Version) Equals(r Version) bool
  • func (v *Version) EqualsString(s string) (ok bool, err error)
  • func (v *Version) Load() (err error)
  • func (v *Version) LoadFrom(dir string) (err error)
  • func (v *Version) Parse(s string) error
  • func (v *Version) Read(b []byte) (err error)
  • func (v *Version) Save() (err error)
  • func (v *Version) SaveTo(dir string) (err error)
  • func (v *Version) String() string
  • func (v *Version) StringNoV() (out string)

Constants

const (
	// Filename names the version file
	Filename = "version.json"
)

Functions

func GetBuildInfo

func GetBuildInfo() (rev string, t time.Time, mod bool, err error)

GetBuildInfo returns the embedded vcs-related information

Types

type Version

type Version struct {
	Major int    `json:"major"`
	Minor int    `json:"minor"`
	Patch int    `json:"patch"`
	Pre   string `json:"pre"`
	Build string `json:"build"`
}

Version Basic SemVer structure

func New

func New() (v Version)

New returns an initial version

func (*Version) Equals

func (v *Version) Equals(r Version) bool

Equals checks if two versions are identical

func (*Version) EqualsString

func (v *Version) EqualsString(s string) (ok bool, err error)

EqualsString checks if version is identical to string

func (*Version) Load

func (v *Version) Load() (err error)

Load loads the version file from the current working directory

func (*Version) LoadFrom

func (v *Version) LoadFrom(dir string) (err error)

LoadFrom loads the version file from the given directory

func (*Version) Parse

func (v *Version) Parse(s string) error

Parse parses a version string into its fields

func (*Version) Read

func (v *Version) Read(b []byte) (err error)

Read reads the version from the given bytes

func (*Version) Save

func (v *Version) Save() (err error)

Save saves the version file to the current working directory

func (*Version) SaveTo

func (v *Version) SaveTo(dir string) (err error)

SaveTo saves the version file to the given directory

func (*Version) String

func (v *Version) String() string

func (*Version) StringNoV

func (v *Version) StringNoV() (out string)

StringNoV returns the version string, without a "v" prefix