commit

Documentation

Index

• type Commit
  • func Parse(s string) (c Commit)
  • func (c Commit) Message() string
• type Footer
  • func (f Footer) String() string
• type Revert
• type Type

Types

type Commit

type Commit struct {
	Type     Type
	Scope    string
	Subject  string
	Body     string
	Breaking bool
	Header   string
	Footers  []Footer
	Merge    bool
	Revert   Revert
}

Commit represents the parsed data from a conventional commit message.

func Parse

func Parse(s string) (c Commit)

Parse parses a commit message and returns a conventional commit.

If the message does not follow the format, then nil is returned.

func (Commit) Message

func (c Commit) Message() string

type Footer

type Footer struct {
	Title string
	Text  string
}

Footer represents a conventional commit footer, which roughly corresponds to a git trailer: Foo-bar: some text.

func (Footer) String

func (f Footer) String() string

type Revert

type Revert struct {
	Header string
	Hash   string
}

Revert represents what this commmit reverts.

type Type

type Type string

const (
	TypeFeature Type = "feat"
	TypeBugFix  Type = "fix"
	TypeRelease Type = "release"
)