relnote docs · Compare · gh relnote · CHANGELOG.md · Next version

Offline GitHub release notes from Conventional Commits

relnote is a stdlib Python changelog CLI and GitHub Action. It reads local git history, groups feat, fix, and BREAKING CHANGE, and prints a Release body — no GitHub API and no config file.

GitHub · OSSDrop · Compare to git-cliff and gh

Why offline

gh release create --generate-notes needs the GitHub API and builds notes around PRs. That is the right default on GitHub.com. relnote is for air-gapped CI, mirrors, or repos that already speak Conventional Commits and want a Release body from git log alone.

Quick start

pip install git+https://github.com/loki-inu/relnote.git
relnote --help
python3 -m relnote --since v0.1.0 --output notes.md --quiet

GitHub Action

After actions/checkout with fetch-depth: 0, use loki-inu/relnote@v0.3.0. The action writes grouped notes for the release job. See the repo README for a draft-release example.

When to pick something else

git-cliff — full changelog files, Tera templates, rich config.
gh release create --generate-notes — official GitHub notes linked to PRs.
swapnanil/relnotes — another stdlib Python CLI if you want optional .relnotes.toml or inferred semver bump.

More detail on the comparison page.