commitparser

Documentation

Index

• Variables
• func Register()
• func ResetCommitParser()
• type CommitParser
  • func NewCommitParser() CommitParser
• type CommitParserPlugin
  • func (CommitParserPlugin) Description() string
  • func (CommitParserPlugin) Name() string
  • func (p *CommitParserPlugin) Parse(commits []string) (string, error)
  • func (CommitParserPlugin) Version() string

Variables

var (
	RegisterCommitParserFn = registerCommitParser
	GetCommitParserFn      = getCommitParser
)

Functions

func Register

func Register()

Register registers the commit parser plugin with the sley plugin system.

func ResetCommitParser

func ResetCommitParser()

Types

type CommitParser

type CommitParser interface {
	Name() string
	Description() string
	Version() string
	Parse(commits []string) (string, error)
}

func NewCommitParser

func NewCommitParser() CommitParser

NewCommitParser returns a new Conventional Commits parser.

type CommitParserPlugin

type CommitParserPlugin struct{}

func (CommitParserPlugin) Description

func (CommitParserPlugin) Description() string

func (CommitParserPlugin) Name

func (CommitParserPlugin) Name() string

func (*CommitParserPlugin) Parse

func (p *CommitParserPlugin) Parse(commits []string) (string, error)

Parse analyzes a slice of commit messages and infers the semver bump type. It returns "major", "minor", "patch", or an error if no inference is possible.

func (CommitParserPlugin) Version

func (CommitParserPlugin) Version() string