Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrEmptyCommitMessage is returned when the commit message is empty ErrEmptyCommitMessage error = errors.New("error: empty commit message") )
Functions ¶
This section is empty.
Types ¶
type Commit ¶
type Commit struct {
// Define commit type, like chore, fix, etc
Type string `yaml:",omitempty"`
// Define commit type scope
Scope string `yaml:",omitempty"`
Footers string `yaml:",omitempty"`
// Define commit title
Title string `yaml:",omitempty"`
// Define commit body
Body string `yaml:",omitempty"`
// Display updatecli credits inside commit message body
HideCredit bool `yaml:",omitempty"`
}
Commit contains conventional commit information More information on what is conventional commits -> https://www.conventionalcommits.org/en/v1.0.0/#summary
func (*Commit) ParseMessage ¶
ParseMessage parses a message then return the commit message title and its body. The message title can't be longer than 72 characters
Click to show internal directories.
Click to hide internal directories.