semver

package

v1.0.0 Latest Latest Go to latest Published: Oct 6, 2021 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gembaadvantage/uplift

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Increment
- func ParseCommit(commit string) Increment
type Version
- func Parse(ver string) (Version, error)
- func (v Version) String() string

Constants ¶

View Source

const (
	// Pattern defines the regular expression for matching a semantic version
	// as a raw sequence of characters
	Pattern = `(v?)(\d+)\.(\d+)\.(\d+)`
)

Variables ¶

View Source

var (
	// Regex for parsing a matching a semantic version
	Regex = regexp.MustCompile(Pattern)
)

Functions ¶

This section is empty.

Types ¶

type Increment ¶

type Increment string

Increment defines the different types of increment that can be performed against a semantic version

const (
	// NoIncrement represents no increment change to a semantic version
	NoIncrement Increment = "None"
	// PatchIncrement represents a patch increment (1.0.x) to a semantic version
	PatchIncrement Increment = "Patch"
	// MinorIncrement represents a minor increment (1.x.0) to a semantic version
	MinorIncrement Increment = "Minor"
	// MajorIncrement represents a major increment (x.0.0) to a semantic version
	MajorIncrement Increment = "Major"
)

func ParseCommit ¶

func ParseCommit(commit string) Increment

ParseCommit will identify the type of increment to perform by parsing the commit message against the conventional commit standards defined, @see: https://www.conventionalcommits.org/en/v1.0.0/

type Version ¶ added in v1.0.0

type Version struct {
	Prefix string
	Patch  uint64
	Minor  uint64
	Major  uint64
	Raw    string
}

Version provides a less strict implementation of a semantic version and supports the optional use of a prefix, which is a common standard with Git tags

func Parse ¶ added in v1.0.0

func Parse(ver string) (Version, error)

Parse ...

func (Version) String ¶ added in v1.0.0

func (v Version) String() string

String outputs the unparsed semantic version

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL