notes

package

v0.14.4 Latest Latest Go to latest Published: Aug 19, 2026 License: MIT Imports: 3 Imported by: 0

Documentation ¶

Overview ¶

Package notes provides release notes generation.

Index ¶

type PR
type ReleaseNotes
- func Generate(commits []conventional.Commit, prMap map[string]PR) ReleaseNotes
type Section

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type PR ¶

type PR struct {
	Number int
	URL    string
}

PR represents a pull request link

type ReleaseNotes ¶

type ReleaseNotes struct {
	Sections []Section
	Body     string // markdown-formatted body
}

ReleaseNotes represents the complete release notes

func Generate ¶

func Generate(commits []conventional.Commit, prMap map[string]PR) ReleaseNotes

Generate creates release notes from a list of commits. prMap: map[commitSHA]PR for linking commits to PRs (pre-fetched by CLI layer) Returns ReleaseNotes with sections grouped by commit type, sorted by importance

type Section ¶

type Section struct {
	Title   string   // e.g., "Features", "Bug Fixes", "Breaking Changes"
	Commits []string // formatted commit lines
}

Section represents a group of commits by type (e.g., "Features", "Bug Fixes")

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL