changes

Documentation

Index

• Variables
• func AlwaysStop(_ *object.Commit) bool
• func NeverStop(_ *object.Commit) bool
• type ChangeSet
  • func Load(r *repo.Repository, stopAt StopAt, guess CommitTypeGuesser) (*ChangeSet, error)
  • func NewChangeSet() *ChangeSet
• type CommitTypeEntry
  • func CommitEntries(order []TypeTag, m map[TypeTag][]string) []CommitTypeEntry
• type CommitTypeGuesser
  • func DefaultGuess(tag TypeTag) CommitTypeGuesser
• type StopAt
  • func StopAtCount(count int) StopAt
  • func StopAtFirstSemver(r *repo.Repository) StopAt
  • func StopAtHash(hash plumbing.Hash) StopAt
  • func StopAtTagMatch(r *repo.Repository, matchString func(s string) bool) StopAt
• type TypeTag
  • func StandardGuess(commit *object.Commit) (TypeTag, error)
• type Types
  • func (t Types) Join(sep string) string

Variables

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

TypesInOrder is the standard ordering of types

Functions

func AlwaysStop

func AlwaysStop(_ *object.Commit) bool

AlwaysStop is an StopAt that accepts every commit

func NeverStop

func NeverStop(_ *object.Commit) bool

NeverStop is an StopAt that accepts nothing, ever

Types

type ChangeSet

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

func Load(r *repo.Repository, stopAt StopAt, guess CommitTypeGuesser) (*ChangeSet, error)

Load creates a new CommitSet from a repository

func NewChangeSet

func NewChangeSet() *ChangeSet

NewChangeSet creates a new, empty change set

type CommitTypeEntry

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

CommitTypeEntry represents a list of messages of a specific type

func CommitEntries

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

CommitEntries returns a list of CommitTypeEntry

type CommitTypeGuesser

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

func DefaultGuess(tag TypeTag) CommitTypeGuesser

DefaultGuess just returns the specified tag if it has to guess

type StopAt

type StopAt func(commit *object.Commit) bool

StopAt is a commit recognizer

func StopAtCount

func StopAtCount(count int) StopAt

StopAtCount accepts the specific count of commits given

func StopAtFirstSemver

func StopAtFirstSemver(r *repo.Repository) StopAt

func StopAtHash

func StopAtHash(hash plumbing.Hash) StopAt

StopAtHash stops when the hash is encountered

func StopAtTagMatch

func StopAtTagMatch(r *repo.Repository, matchString func(s string) bool) StopAt

StopAtTagMatch stops when the tag matches a tag referring to this commit

type TypeTag

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

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

StandardGuess guesses the commit type by examining the commit

type Types

type Types []TypeTag

Types is a list of TypeTag

func (Types) Join

func (t Types) Join(sep string) string

Join joins the specified Types using the given separator