Documentation
¶
Index ¶
Constants ¶
View Source
const ( TrailerKeyBreakingChangePrefix = "BREAKING" TrailerKeyBreakingChange = TrailerKeyBreakingChangePrefix + " CHANGE" TrailerKeyBreakingChangeAlt = TrailerKeyBreakingChangePrefix + "-CHANGE" )
Variables ¶
View Source
var ( ErrInvalidType = errors.New("invalid commit type") ErrInvalidScope = errors.New("invalid commit scope") ErrInvalidSubject = errors.New("invalid commit subject") ErrInvalidMessage = errors.New("invalid commit message") ErrInvalidTrailer = errors.New("invalid trailer in commit message") )
Functions ¶
This section is empty.
Types ¶
type CommitMessage ¶
type CommitMessage struct {
Type string
Scope string
Subject string
Body string
Trailers []Trailer
Breaking bool
Revert bool
Merge bool
}
func Parse ¶
func Parse(message string) (CommitMessage, error)
type ParseError ¶
type ParseError struct {
Pos int
// contains filtered or unexported fields
}
func (ParseError) Error ¶
func (err ParseError) Error() string
func (ParseError) Unwrap ¶
func (err ParseError) Unwrap() error
Source Files
Click to show internal directories.
Click to hide internal directories.