conventional

Documentation

Index

• func Generate(newVersion string, commits []*Commit) string
• type Commit
  • func Parse(message string) (*Commit, error)

Functions

func Generate

func Generate(newVersion string, commits []*Commit) string

Generate creates a markdown changelog from a list of commits for a new version.

Types

type Commit

type Commit struct {
	Type       string
	Scope      string
	Subject    string
	Body       string
	Footer     map[string]string
	IsBreaking bool
}

Commit represents a parsed conventional commit message.

func Parse

func Parse(message string) (*Commit, error)

Parse parses a raw git commit message string into a Commit struct.