Skip to content

Ali-Ali-369/release-note-forge

Repository files navigation

Release Note Forge

Release Note Forge turns conventional commit text into release notes and a recommended semantic-version bump. It is built for maintainers who need a fast draft before editing a changelog or publishing a release.

The first version is local-first and deterministic:

  • Groups commits into features, fixes, docs, maintenance, tests, and breaking changes.
  • Recommends major, minor, patch, or none.
  • Emits Markdown or JSON.
  • Works with pasted commit logs, CI artifacts, or git log --oneline output.

Install

python -m pip install -e .

No runtime dependencies are required beyond Python 3.11+.

Usage

python -m release_note_forge examples/commits.txt --version 0.4.2
python -m release_note_forge examples/commits.txt --format json

Example input:

feat(cli): add JSON output
fix(parser): handle scoped commits
docs: update maintainer workflow

Development

python -m unittest discover -s tests
python -m release_note_forge examples/commits.txt --version 0.4.2

License

MIT

About

Local release-note drafts from conventional commits

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages