text

Documentation

Index

• func BuildHistory(messages []Commit) string
• func LinkToCommit(projectURL string, commitID string) string
• func SplitSections(categorisedCommits []Commit) map[string][]Commit
• func TrimMessage(message string) string
• type Commit
  • func ParseCommitMessage(commitMessage string) Commit
• type Hash
  • func (h Hash) String() string
• type ReleaseNotes
  • func (r *ReleaseNotes) Generate(sections map[string][]Commit) string

Functions

func BuildHistory

func BuildHistory(messages []Commit) string

BuildHistory takes commit messages and builds a complete list

func LinkToCommit

func LinkToCommit(projectURL string, commitID string) string

LinkToCommit to commit provides a formatted link to a commit

func SplitSections

func SplitSections(categorisedCommits []Commit) map[string][]Commit

SplitSections accepts categorised commits and further organises them into separate sections for release notes

func TrimMessage

func TrimMessage(message string) string

TrimMessage returns only the first line of commit message

Types

type Commit

type Commit struct {
	Category string
	Heading  string
	Body     string
	Scope    string
	Hash     Hash
}

Commit is a parsed commit that contains information about category, scope and heading

func ParseCommitMessage

func ParseCommitMessage(commitMessage string) Commit

ParseCommitMessage creates a slice of Commits that contain information about category and scope parsed from commit message

type Hash

type Hash [20]byte

Hash describes a commit hash

func (Hash) String

func (h Hash) String() string

type ReleaseNotes

type ReleaseNotes struct {
	Simple bool
}

ReleaseNotes holds the required settings for generating ReleaseNotes

func (*ReleaseNotes) Generate

func (r *ReleaseNotes) Generate(sections map[string][]Commit) string

Generate generates the output mentioned in the expected-output.md