Skip to content

Repository files navigation

Release Note Kit

Release Note Kit creates a clean Markdown release-note draft from conventional Git commit subjects. It is intentionally small, dependency-free, and transparent about how it groups changes.

Install

python -m pip install .

Use

Run inside a Git repository:

release-note-kit v0.2.0 --revision v0.1.0..HEAD
release-note-kit v0.2.0 --output RELEASE_NOTES.md
release-note-kit v0.2.0 --date 2026-08-15 --repository owner/project

Commit subjects such as feat: add export, fix(parser): handle empty input, and feat!: remove legacy mode are grouped into readable sections. The tool also reads full commit bodies, so a BREAKING CHANGE: or BREAKING-CHANGE: footer is reported even when the subject has no !. Breaking changes appear once in their own section instead of being duplicated in a regular category. When --repository owner/project is supplied, references such as #42 become clickable GitHub issue links. Subjects outside the conventional format remain visible under Other rather than being silently discarded.

Development

PYTHONPATH=src python -m unittest discover -s tests -v

Support

If this project helps you, you can support its continued development.

  • USDT — BEP20 / BNB Smart Chain: 0x9ee9a9ef2b9679fa99b3b36313bc581a66b05cfb
  • Bitcoin — BTC mainnet: bc1qsg09m3yj4d8d026ayfhhazu823h8vntu8wph95

Please send funds only on the stated network. Never send a seed phrase or private key.

About

Generate readable release notes from conventional Git commit subjects.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages