README
¶
semver
This is a copy of Hashicorp's go-version package.
It is included for version stability.
The original LICENSE file is included, and applies for any files within this package.
Version Parsing and Comparison
v1, err := semver.NewVersion("1.2")
v2, err := semver.NewVersion("1.5+metadata")
// Comparison example. There is also GreaterThan, Equal, and just
// a simple Compare that returns an int allowing easy >=, <=, etc.
if v1.LessThan(v2) {
fmt.Printf("%s is less than %s", v1, v2)
}
Version Constraints
v1, err := semver.NewVersion("1.2")
// Constraints example.
constraints, err := semver.NewConstraint(">= 1.0, < 1.4")
if constraints.Check(v1) {
fmt.Printf("%s satisfies constraints %s", v1, constraints)
}
Version Sorting
versionsRaw := []string{"1.1", "0.7.1", "1.4-beta", "1.4", "2"}
versions := make([]*semver.Version, len(versionsRaw))
for i, raw := range versionsRaw {
v, _ := semver.NewVersion(raw)
versions[i] = v
}
// After this, the versions are properly sorted
sort.Sort(semver.Collection(versions))
Documentation
¶
Overview ¶
Package semver is a fork of Hashicorp's semver package. It refactors some tests but leaves the bulk of the functionality intact.
Index ¶
- Constants
- type Collection
- type Constraint
- type Constraints
- type Version
- func (v *Version) BumpMajor()
- func (v *Version) BumpMinor()
- func (v *Version) BumpPatch()
- func (v *Version) Compare(other *Version) int
- func (v *Version) Equal(o *Version) bool
- func (v *Version) GreaterThan(o *Version) bool
- func (v *Version) LessThan(o *Version) bool
- func (v *Version) Major() (major int64)
- func (v *Version) Metadata() string
- func (v *Version) Minor() (minor int64)
- func (v *Version) Patch() (patch int64)
- func (v *Version) Prerelease() string
- func (v *Version) Segments() []int
- func (v *Version) Segments64() []int64
- func (v *Version) String() string
Constants ¶
const VersionRegexpRaw string = `v?([0-9]+(\.[0-9]+)*?)` +
`(-?([0-9A-Za-z\-~]+(\.[0-9A-Za-z\-~]+)*))?` +
`(\+([0-9A-Za-z\-~]+(\.[0-9A-Za-z\-~]+)*))?` +
`?`
VersionRegexpRaw is the raw regular expression string used for testing the validity of a version.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Collection ¶
type Collection []*Version
Collection is a type that implements the sort.Interface interface so that versions can be sorted.
func (Collection) Len ¶
func (v Collection) Len() int
func (Collection) Less ¶
func (v Collection) Less(i, j int) bool
func (Collection) Swap ¶
func (v Collection) Swap(i, j int)
type Constraint ¶
type Constraint struct {
// contains filtered or unexported fields
}
Constraint represents a single constraint for a version, such as ">= 1.0".
func (*Constraint) Check ¶
func (c *Constraint) Check(v *Version) bool
Check tests if a constraint is validated by the given version.
func (*Constraint) String ¶
func (c *Constraint) String() string
type Constraints ¶
type Constraints []*Constraint
Constraints is a slice of constraints. We make a custom type so that we can add methods to it.
func NewConstraint ¶
func NewConstraint(v string) (Constraints, error)
NewConstraint will parse one or more constraints from the given constraint string. The string must be a comma-separated list of constraints.
func (Constraints) Check ¶
func (cs Constraints) Check(v *Version) bool
Check tests if a version satisfies all the constraints.
func (Constraints) String ¶
func (cs Constraints) String() string
Returns the string format of the constraints
type Version ¶
type Version struct {
// contains filtered or unexported fields
}
Version represents a single version.
func Must ¶
Must is a helper that wraps a call to a function returning (*Version, error) and panics if error is non-nil.
func NewVersion ¶
NewVersion parses the given version and returns a new Version.
func (*Version) BumpMajor ¶
func (v *Version) BumpMajor()
BumpMajor increments the Major field by 1 and resets all other fields to their default values
func (*Version) BumpMinor ¶
func (v *Version) BumpMinor()
BumpMinor increments the Minor field by 1 and resets all other fields to their default values
func (*Version) BumpPatch ¶
func (v *Version) BumpPatch()
BumpPatch increments the Patch field by 1 and resets all other fields to their default values
func (*Version) Compare ¶
Compare compares this version to another version. This returns -1, 0, or 1 if this version is smaller, equal, or larger than the other version, respectively.
If you want boolean results, use the LessThan, Equal, or GreaterThan methods.
func (*Version) GreaterThan ¶
GreaterThan tests if this version is greater than another version.
func (*Version) Metadata ¶
Metadata returns any metadata that was part of the version string.
Metadata is anything that comes after the "+" in the version. For example, with "1.2.3+beta", the metadata is "beta".
func (*Version) Prerelease ¶
Prerelease returns any prerelease data that is part of the version, or blank if there is no prerelease data.
Prerelease information is anything that comes after the "-" in the version (but before any metadata). For example, with "1.2.3-beta", the prerelease information is "beta".
func (*Version) Segments ¶
Segments returns the numeric segments of the version as a slice of ints.
This excludes any metadata or pre-release information. For example, for a version "1.2.3-beta", segments will return a slice of 1, 2, 3.
func (*Version) Segments64 ¶
Segments64 returns the numeric segments of the version as a slice of int64s.
This excludes any metadata or pre-release information. For example, for a version "1.2.3-beta", segments will return a slice of 1, 2, 3.
Source Files