semver

package

v0.1.1 Latest Latest Go to latest Published: Apr 11, 2021 License: MIT Imports: 7 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 ¶

type BumpOptions
type Bumper
- func NewBumper(out io.Writer, opts BumpOptions) Bumper
- func (b Bumper) Bump() error
type Increment
- func ParseCommit(commit string) Increment

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BumpOptions ¶

type BumpOptions struct {
	FirstVersion string
	DryRun       bool
	Verbose      bool
}

BumpOptions configures the behaviour when bumping a semantic version

type Bumper ¶

type Bumper struct {
	// contains filtered or unexported fields
}

Bumper is capable of bumping a semantic version associated with a git repository based on the conventional commits standard: @see https://www.conventionalcommits.org/en/v1.0.0/

func NewBumper ¶

func NewBumper(out io.Writer, opts BumpOptions) Bumper

NewBumper initialises a new semantic version bumper

func (Bumper) Bump ¶

func (b Bumper) Bump() error

Bump a semantic version based on the latest git log message within the associated git repository. Versions are incremented using the conventional commits standard. Once a version has been bumped, it will be tagged against the latest commit

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/

Source Files ¶

View all Source files

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