Documentation
¶
Overview ¶
Package changelog parses the embedded CHANGELOG.md (see the top-level changelog package) into structured, filterable entries (ADR-0041).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EmbeddedRange ¶ added in v0.40.0
EmbeddedRange returns release payloads in the inclusive selected range.
func EmbeddedSince ¶ added in v0.40.0
EmbeddedSince returns release payloads newer than version.
func EmbeddedVersion ¶ added in v0.40.0
EmbeddedVersion returns one selected release payload.
Types ¶
type Entry ¶
type Entry struct {
Version string // e.g. "0.5.1", no leading "v"
Date string // YYYY-MM-DD
Raw string // the section text, header line through end of body
}
Entry is one version's changelog section.
func Load ¶
Load reads "CHANGELOG.md" from fsys and parses it. touches-state: tooling/changelog-and-release:changelog-embed-decodes - embedded CHANGELOG.md decode; proof in changelog_test.go
func Parse ¶
Parse splits raw CHANGELOG.md content into ordered entries (newest first, matching file order). Content before the first header (the title and intro prose) is discarded - callers wanting the whole file read it directly instead. Parse errors if no version header is found.
func Range ¶
Range returns every entry in [from, to] inclusive, newest first. from must be chronologically older than or equal to the to end (git range convention: from..to); a reversed pair errors rather than silently reordering. touches-state: tooling/changelog-and-release:changelog-range-chronological - chronological range selection; proof in changelog_test.go
Source Files