text

Documentation

Index

• func BuildHistory(messages []quoad.Commit) string
• func LinkToCommit(projectURL string, commitID string) string
• func SplitSections(categorisedCommits []quoad.Commit) map[string][]quoad.Commit
• func TrimMessage(message string) string
• type ReleaseNotes
  • func (r *ReleaseNotes) Generate(sections map[string][]quoad.Commit, dryRun bool) string

Functions

func BuildHistory

func BuildHistory(messages []quoad.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 []quoad.Commit) map[string][]quoad.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 ReleaseNotes

type ReleaseNotes struct {
	Complex bool
}

ReleaseNotes holds the required settings for generating ReleaseNotes

func (*ReleaseNotes) Generate

func (r *ReleaseNotes) Generate(sections map[string][]quoad.Commit, dryRun bool) string

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