mirror of
https://github.com/iffy/changer
synced 2026-01-10 08:31:17 +00:00
No description
| .github/workflows | ||
| changes | ||
| src | ||
| tests | ||
| .gitignore | ||
| CHANGELOG.md | ||
| changer.nimble | ||
| default.config.toml | ||
| LICENSE.md | ||
| README.md | ||
changer makes it easy to manage a CHANGELOG.md file. It works in Nim projects and other languages, too.
Installation
nimble install changer
Configuration
You can configure how changer behaves by editing the changes/config.toml file.
Usage
Start a changelog in a project by running:
changer init
Every time you want to add something to the changelog, make a new Markdown file in ./changes/ named like this:
fix-NAME.mdnew-NAME.mdbreak-NAME.mdother-NAME.md
Use the tool to add a changelog entry:
changer add
When you're ready to release a new version, preview the new changelog with:
changer bump -n
Then make the new changelog (and update the version of any .nimble file):
changer bump