versionutils

Documentation

Index

• Constants
• Variables
• func GetDependencyVersionInfo(pkgName string, toml *TomlWrapper) (*dep.VersionInfo, error)
• func GetGitVersion(relativeRepoDir string) (string, error)
• func GetImageVersion(version *Version) string
• func GetTag(version string) string
• func GetTomlVersion(pkgName string, toml *TomlWrapper) (string, error)
• func GetVersion(pkgName string, tomlTree []*toml.Tree) (string, error)
• func GetVersionFromTag(shouldBeAVersion string) (string, error)
• func IsGreaterThanTag(greaterTag, lesserTag string) (bool, error)
• func MatchesRegex(tag string) bool
• func ParseToml() ([]*toml.Tree, error)
• func ParseTomlFromDir(relativeDir string) ([]*toml.Tree, error)
• func ParseTomlOverrides() ([]*toml.Tree, error)
• func ParseTomlOverridesFromDir(relativeDir string) ([]*toml.Tree, error)
• func PinGitVersion(relativeRepoDir string, semVerVersion string) error
• type TomlWrapper
  • func ParseFullToml() (*TomlWrapper, error)
  • func ParseFullTomlFromDir(relativeDir string) (*TomlWrapper, error)
• type Version
  • func GetReleaseVersionOrExitGracefully() *Version
  • func NewRcVersion(major, minor, patch, rc int) *Version
  • func NewVersion(major, minor, patch int) *Version
  • func ParseVersion(tag string) (*Version, error)
  • func (v *Version) Equals(other *Version) bool
  • func (v *Version) IncrementVersion(breakingChange bool) *Version
  • func (v *Version) IsGreaterThan(lesser *Version) bool
  • func (v *Version) IsGreaterThanOrEqualTo(lesser *Version) (bool, error)
  • func (v *Version) String() string

Constants

const (
	SemverNilVersionValue = "v0.0.0"
	SemverMinimumVersion  = "v0.0.1"
)

SemverLowerBound is the "nil" value for changelog versions It is not itself a valid version but it allows us to use our semver validation on the v0.0.1 edge case

Variables

var (
	UnableToFindVersionInTomlError = func(pkgName string) error {
		return fmt.Errorf("unable to find version for %s in toml", pkgName)
	}
	FailedCommandError = func(err error, args []string, output string) error {
		return errors.Wrapf(err, "%v failed: %s", args, output)
	}
)

var (
	InvalidSemverVersionError = func(tag string) error {
		return errors.Errorf("Tag %s is not a valid semver version, must be of the form vX.Y.Z[-rc#]", tag)
	}
	InvalidReleaseCandidateTag = func(tagAndBuildMetadata string) error {
		return errors.Errorf("Semver tag %s is not valid release candidate (must be 'rc' followed by int, e.g. 'rc5')", tagAndBuildMetadata)
	}
)

var (
	Zero = Version{
		Major: 0,
		Minor: 0,
		Patch: 0,
	}

	StableApiVersion = Version{
		Major: 1,
		Minor: 0,
		Patch: 0,
	}
)

Functions

func GetDependencyVersionInfo

func GetDependencyVersionInfo(pkgName string, toml *TomlWrapper) (*dep.VersionInfo, error)

Returns the version of the given package together with the type of version identifier, i.e. revision, version, branch.

func GetGitVersion

func GetGitVersion(relativeRepoDir string) (string, error)

Deprecated: use git.GetGitRefInfo

func GetImageVersion

func GetImageVersion(version *Version) string

func GetTag

func GetTag(version string) string

Deprecated: use git.AppendTagPrefix

func GetTomlVersion

func GetTomlVersion(pkgName string, toml *TomlWrapper) (string, error)

Deprecated: use GetDependencyVersionInfo

func GetVersion

func GetVersion(pkgName string, tomlTree []*toml.Tree) (string, error)

Deprecated: Use GetTomlVersion instead

func GetVersionFromTag

func GetVersionFromTag(shouldBeAVersion string) (string, error)

func IsGreaterThanTag

func IsGreaterThanTag(greaterTag, lesserTag string) (bool, error)

func MatchesRegex

func MatchesRegex(tag string) bool

func ParseToml

func ParseToml() ([]*toml.Tree, error)

Deprecated: Use ParseFullToml instead

func ParseTomlFromDir

func ParseTomlFromDir(relativeDir string) ([]*toml.Tree, error)

Deprecated: Use ParseFullTomlFromDir instead

func ParseTomlOverrides

func ParseTomlOverrides() ([]*toml.Tree, error)

Deprecated: Use ParseFullToml instead

func ParseTomlOverridesFromDir

func ParseTomlOverridesFromDir(relativeDir string) ([]*toml.Tree, error)

Deprecated: Use ParseFullTomlFromDir instead

func PinGitVersion

func PinGitVersion(relativeRepoDir string, semVerVersion string) error

Deprecated: use git.PinDependencyVersion This function prepends a "v" to the semver and then tries to 'git checkout' the resulting tag in the given directory.

Types

type TomlWrapper

type TomlWrapper struct {
	Overrides   []*toml.Tree
	Constraints []*toml.Tree
}

func ParseFullToml

func ParseFullToml() (*TomlWrapper, error)

func ParseFullTomlFromDir

func ParseFullTomlFromDir(relativeDir string) (*TomlWrapper, error)

type Version

type Version struct {
	Major            int
	Minor            int
	Patch            int
	ReleaseCandidate int
}

func GetReleaseVersionOrExitGracefully

func GetReleaseVersionOrExitGracefully() *Version

func NewRcVersion

func NewRcVersion(major, minor, patch, rc int) *Version

func NewVersion

func NewVersion(major, minor, patch int) *Version

func ParseVersion

func ParseVersion(tag string) (*Version, error)

func (*Version) Equals

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

func (*Version) IncrementVersion

func (v *Version) IncrementVersion(breakingChange bool) *Version

func (*Version) IsGreaterThan

func (v *Version) IsGreaterThan(lesser *Version) bool

func (*Version) IsGreaterThanOrEqualTo

func (v *Version) IsGreaterThanOrEqualTo(lesser *Version) (bool, error)

func (*Version) String

func (v *Version) String() string