cmd

Documentation

Index

• Constants
• func Execute()
• type Commit
• type Release
• type ReleaseType

Constants

const (
	Feature = "feat"
	Fix     = "fix"
)

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type Commit

type Commit struct {
	Type          string
	Scope         string
	Description   string
	BodyAndFooter string
	Footer        string

	Breaking bool

	Hash       string
	ShortHash  string
	AuthorName string
}

Commit represents the conventional commit understanding of a git commit.

type Release

type Release struct {
	Version         *semver.Version
	PreviousVersion *semver.Version
	Date            string
	Breaking        []Commit
	Features        []Commit
	Fixes           []Commit

	CommitURL string
}

Release represents all the meta data about a release.

type ReleaseType

type ReleaseType int

ReleaseType corresponds the semantic version numbers.

const (
	Major ReleaseType = iota
	Minor
	Patch
)