No description
Find a file
2024-09-30 09:34:40 -04:00
.github/workflows Not ready for m1 yet 2024-09-30 09:34:40 -04:00
changes Bump to v0.9.1 2024-04-19 09:35:34 -04:00
src Add [[duplicate]] 2024-03-09 10:52:42 -05:00
tests Add [[duplicate]] 2024-03-09 10:52:42 -05:00
.gitignore Add replacements 2020-12-01 08:49:17 -05:00
CHANGELOG.md Bump to v0.9.1 2024-04-19 09:35:34 -04:00
changer.nimble Bump to v0.9.1 2024-04-19 09:35:34 -04:00
default.config.toml Add [[duplicate]] 2024-03-09 10:52:42 -05:00
LICENSE.md Add LICENSE 2020-12-09 12:36:10 -05:00
README.md Bump to v0.4.1 2021-03-17 08:37:49 -04:00

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.md
  • new-NAME.md
  • break-NAME.md
  • other-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