version

Documentation

Overview

The version package helps other packages to provide information about their current version and compare it to others. It follows the idea of semantic versioning.

Index

• Constants
• type Version
  • func New(major, minor, patch int, prmds ...string) Version
  • func PackageVersion() Version

Constants

const (
	Metadata = "+"
)

Types

type Version

type Version interface {
	fmt.Stringer

	// Major returns the major version.
	Major() int

	// Minor returns the minor version.
	Minor() int

	// Patch return the path version.
	Patch() int

	// PreRelease returns a possible pre-release of the version.
	PreRelease() string

	// Metadata returns a possible build metadata of the version.
	Metadata() string

	// Less returns true if this version is less than the passed one.
	Less(cv Version) bool
}

Version defines the interface of a version.

func New

func New(major, minor, patch int, prmds ...string) Version

New returns a simple version instance. Parts of pre-release and metadata are passed as optional strings separated by version.Metadata ("+").

func PackageVersion

func PackageVersion() Version

PackageVersion returns the version of the version package.