semver

Documentation

Overview

Package semver provides functionality to parse and process semantic versions, as they are used in multiple components of Constellation.

Index

• type Semver
  • func NewSemver(version string) (Semver, error)
  • func (v Semver) Compare(other Semver) int
  • func (v Semver) CompatibleWithBinary() bool
  • func (v Semver) IsUpgradeTo(other Semver) bool
  • func (v Semver) MarshalJSON() ([]byte, error)
  • func (v Semver) NextMinor() string
  • func (v Semver) String() string
  • func (v *Semver) UnmarshalJSON(data []byte) error

Types

type Semver

type Semver struct {
	Major int
	Minor int
	Patch int
}

Semver represents a semantic version.

func NewSemver

func NewSemver(version string) (Semver, error)

NewSemver returns a Version from a string.

func (Semver) Compare

func (v Semver) Compare(other Semver) int

Compare compares two versions. It relies on the semver.Compare function internally.

func (Semver) CompatibleWithBinary

func (v Semver) CompatibleWithBinary() bool

CompatibleWithBinary returns if a version is compatible version of the current built binary. It checks if the version of the binary is equal or greater than the current version and allows a drift of at most one minor version.

func (Semver) IsUpgradeTo

func (v Semver) IsUpgradeTo(other Semver) bool

IsUpgradeTo returns if a version is an upgrade to another version. It checks if the version of v is greater than the version of other and allows a drift of at most one minor version.

func (Semver) MarshalJSON

func (v Semver) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (Semver) NextMinor

func (v Semver) NextMinor() string

NextMinor returns the next minor version in the format "vMAJOR.MINOR".

func (Semver) String

func (v Semver) String() string

String returns the string representation of the version.

func (*Semver) UnmarshalJSON

func (v *Semver) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.