relnotes

Documentation

Overview

Changelog-file fallback: many projects never publish GitHub Releases (Phoenix stopped at v1.5.3; most GitLab-, Codeberg- and Bitbucket-hosted projects never started) but keep a CHANGELOG.md at the repository root. When the release-list path yields nothing for a change, we fetch the repo's changelog file at the verified tag via the forge's raw endpoint and extract the sections covering (old, new] — same excerpting, same caps, same sanitizing as release bodies.

Package relnotes fetches upstream release notes for bumped packages. It builds on the taglink layer: a change whose ReleaseURL points at a verified GitHub release tag gets the notes for that release — and, when the bump skips versions, the notes for every release in between (one GitHub API call per repository, opt-in via -changelogs).

Index

• Variables
• func Annotate(diffs []diffx.FileDiff, token string) (warnings []string)
• func Excerpt(body string) string

Variables

var APIBase = "https://api.github.com"

APIBase is swappable for tests.

var Concurrency = 8

Concurrency is the number of repositories fetched in parallel.

var Fallback = false

Fallback also queries changes that lack a taglink-verified ReleaseURL but whose deps.dev source repo is on github.com, resolving the tag against the fetched release list itself. Used by the wasm playground, where taglink cannot run (git smart-HTTP has no CORS headers).

var MaxRepos = 40

MaxRepos caps how many distinct repositories one run will query, to stay well inside unauthenticated API rate limits.

var RawGitHub = "https://raw.githubusercontent.com"

RawGitHub is swappable for tests.

Functions

func Annotate

func Annotate(diffs []diffx.FileDiff, token string) (warnings []string)

Annotate fills ReleaseNotes on changes whose ReleaseURL is a GitHub release-tag link. Best-effort: unreachable repos are skipped; the only surfaced warning is a rate-limit hint. token may be empty.

func Excerpt

func Excerpt(body string) string

Excerpt trims a release body down to a short, terminal-safe extract.