changes

package

v0.3.0 Latest Latest Go to latest Published: Feb 17, 2022 License: MIT Imports: 10 Imported by: 0

Details

This section is empty.

View Source

var TypesInOrder = Types{
	"feat",
	"fix",
	"test",
	"docs",
	"build",
	"refactor",
	"chore",
}

TypesInOrder is the standard ordering of types

This section is empty.

type ChangeSet struct {
	BreakingChanges []string
	Commits         map[TypeTag][]string
}

ChangeSet represents the list of all changes in a commit stream (presumably from a base tag)

func Load(r *git.Repository, stopAt plumbing.Hash, guess CommitTypeGuesser) (*ChangeSet, error)

Load creates a new CommitSet from a repository

func NewChangeSet() *ChangeSet

NewChangeSet creates a new, empty change set

type CommitTypeEntry struct {
	Name     string
	Tag      TypeTag
	Order    int
	Messages []string
}

CommitTypeEntry represents a list of messages of a specific type

func CommitEntries(order []TypeTag, m map[TypeTag][]string) []CommitTypeEntry

CommitEntries returns a list of CommitTypeEntry

type CommitTypeGuesser func(commit *object.Commit) TypeTag

CommitTypeGuesser is a guess function to guess commit type from the commit. StandardGuess can be used as a base to fill this in.

func DefaultGuess(tag TypeTag) CommitTypeGuesser

DefaultGuess just returns the specified tag if it has to guess

type TypeTag string

TypeTag represents the type of a commit. There is a pre-defined set, but it can also be dynamically extended.

var NoClue TypeTag = "--no clue--"

func StandardGuess(commit *object.Commit) (TypeTag, error)

StandardGuess guesses the commit type by examining the commit

type Types []TypeTag

Types is a list of TypeTag

func (t Types) Join(sep string) string

Join joins the specified Types using the given separator