logloom

Changelogs in. JSON, Markdown, and friends out. A CLI and Rust library for Markdown histories, release notes, and news fragments.

Input formats

• Keep a Changelog, including component categories
• Conventional Changelog
• Generic Markdown
• GitHub Release Notes
• Changesets
• Towncrier
• Debian Changelog
• GNU NEWS
• GNU ChangeLog

Syntax and limits - All examples - Output formats

Yes, there are this many ways to write down "fixed a bug".

Install

Grab a checkout and Rust 1.99.1, then:

cargo install --path . --locked

Usage

logloom parse
logloom detect
logloom validate
logloom parse CHANGELOG.md --input-format conventional-changelog
logloom parse CHANGELOG.md --latest --category Fixed -o release.json
logloom parse CHANGELOG.md --latest --output-format markdown -o release.md
cat CHANGELOG.md | logloom parse -
logloom --help

No file argument? It'll read CHANGELOG.md in the current directory. The result goes to stdout, complaints go to stderr. JSON is the default. If there's an error, stdout stays empty.

Try it straight from the checkout:

cargo run -- parse examples/keep-a-changelog.md

More examples, the Rust API, and the small print live in the docs. Project changes live in the changelog.

License

MIT