commitanalyser

Documentation

Index

• Variables
• func DeterminateNextReleaseVersion(commits []vcsapi.Commit, commitPatternList []string, rules []CommitVersionRule, ...) (string, error)
• type CommitVersionRule

Variables

var ConventionalCommitPattern = `(?P<type>[A-Za-z]+)((?:\((?P<scope>[^()\r\n]*)\)|\()?(?P<breaking>!)?)(:\s?(?P<subject>.*))?`

ConventionalCommitPattern is a regex pattern of the Conventional Commits spec - https://www.conventionalcommits.org/en/v1.0.0/

var DefaultReleaseVersionRules = []CommitVersionRule{
	{
		Type:    `feat`,
		Release: `minor`,
	},
	{
		Type:    `refactor`,
		Release: `minor`,
	},
	{
		Type:    `fix`,
		Release: `patch`,
	},
	{
		Type:    `ci`,
		Release: `patch`,
	},
	{
		Type:    `build`,
		Release: `patch`,
	},
	{
		Type:    `docs`,
		Release: `patch`,
	},
	{
		Type:    `perf`,
		Release: `patch`,
	},
	{
		Type:    `test`,
		Release: `patch`,
	},
	{
		Type:    `style`,
		Release: `patch`,
	},
	{
		Type:    `chore`,
		Release: `patch`,
	},
}

Functions

func DeterminateNextReleaseVersion

func DeterminateNextReleaseVersion(commits []vcsapi.Commit, commitPatternList []string, rules []CommitVersionRule, previousVersionStr string) (string, error)

Types

type CommitVersionRule

type CommitVersionRule struct {
	Type    string
	Scope   string
	Release string // major / minor / patch
}