text

package

v0.9.7 Latest Latest Go to latest Published: Mar 10, 2022 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func BuildHistory(messages []quoad.Commit) string

BuildHistory takes commit messages and builds a complete list

func LinkToCommit(projectURL string, commitID string) string

LinkToCommit to commit provides a formatted link to a commit

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(message string) string

TrimMessage returns only the first line of commit message

type ReleaseNotes struct {
	Complex bool
}

ReleaseNotes holds the required settings for generating ReleaseNotes

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

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