I love projects that keep an accurate changelog. But most people (me included) don't like maintaining a changelog or fixing conflicts in the changelog. With changer you can add a conflict-free, easy-to-maintain changelog to your project!
Initial setup:
nimble install changer
mkdir myproject && cd myproject
changer init
Any time you want to add a new changelog entry run changer add and follow the two prompts:
$ changer add
Change type:
[F]ix
[N]ew feature
[B]reaking change
[O]ther (default)
?
n
Describe change (this will show up in the changelog):
This project has a changelog now!
changes/new-This-project-has-20211005-132645.md
When you're ready to release a new version run changer bump to combine all pending changes into the CHANGELOG.md file.
$ cat CHANGELOG.md
# v0.1.0 - 2021-10-05
- **NEW:** This project has a changelog now!
- **FIX:** Fixed a broken thing
Changer can also convert issue numbers into links (or do other simple substitutions), automatically change the version in your .nimble file or even a package.json file. Happy coding!
Name: changer
Author: iffy
Posting:
I love projects that keep an accurate changelog. But most people (me included) don't like maintaining a changelog or fixing conflicts in the changelog. With
changeryou can add a conflict-free, easy-to-maintain changelog to your project!Initial setup:
Any time you want to add a new changelog entry run
changer addand follow the two prompts:When you're ready to release a new version run
changer bumpto combine all pending changes into theCHANGELOG.mdfile.Changer can also convert issue numbers into links (or do other simple substitutions), automatically change the version in your
.nimblefile or even apackage.jsonfile. Happy coding!