commitanalyser

package

v0.2.0-rc.21 Latest Latest Go to latest Published: Jun 6, 2021 License: MIT Imports: 5 Imported by: 0

Details

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

Repository

github.com/cidverse/cid

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DeterminateNextReleaseVersion(commits []vcsrepository.Commit, commitPatternList []string, ...) (string, error)
type CommitVersionRule
type ReleaseType

Constants ¶

This section is empty.

Variables ¶

View Source

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

Conventional Commits - https://www.conventionalcommits.org/en/v1.0.0/

View Source

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`,
	},
}

Functions ¶

func DeterminateNextReleaseVersion ¶

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

Types ¶

type CommitVersionRule ¶

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

type ReleaseType ¶

type ReleaseType int32

const (
	ReleaseNone  ReleaseType = 0
	ReleasePatch ReleaseType = 1
	ReleaseMinor ReleaseType = 2
	ReleaseMajor ReleaseType = 3
)

Source Files ¶

View all Source files

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