semver

Documentation

Overview

Package semver provides functionalities for working with semantic versions. For more information about semantic versioning, visit https://semver.org.

Index

• type SemVer
  • func Parse(semver string) (SemVer, bool)
  • func (v SemVer) Next() SemVer
  • func (v SemVer) ReleaseMajor() SemVer
  • func (v SemVer) ReleaseMinor() SemVer
  • func (v SemVer) ReleasePatch() SemVer
  • func (v SemVer) String() string
  • func (v SemVer) TagName() string

Types

type SemVer

type SemVer struct {
	Major      uint
	Minor      uint
	Patch      uint
	Prerelease []string
	Metadata   []string
}

SemVer represents a semantic version.

func Parse

func Parse(semver string) (SemVer, bool)

Parse gets a semantic version string and returns a SemVer. If the second return value is false, it implies that the input semver was incorrect.

func (SemVer) Next

func (v SemVer) Next() SemVer

Next creates a new semantic version by increasing the patch version by one.

func (SemVer) ReleaseMajor

func (v SemVer) ReleaseMajor() SemVer

ReleaseMajor creates a new semantic version for a major release.

func (SemVer) ReleaseMinor

func (v SemVer) ReleaseMinor() SemVer

ReleaseMinor creates a new semantic version for a minor release.

func (SemVer) ReleasePatch

func (v SemVer) ReleasePatch() SemVer

ReleasePatch creates a new semantic version for a patch release.

func (SemVer) String

func (v SemVer) String() string

String returns the string representation of the current semantic version.

func (SemVer) TagName

func (v SemVer) TagName() string

TagName returns a git tag name for the current semantic version.