This directory includes temporary changelog entries, in the form of simple .json files. This was done to prevent merge conflicts when modifying the same CHANGELOG.md file in many PR's at once.

Every pull request in this repository requires a new changelog entry to be created in this directory, asserted by a GitHub actions workflow. The commit workflow will fail in any PR that does not have a new .changelogs/*.json file added. If a pushed commit does not have a PR associated with it, the check is skipped entirely.

To disable this check, simply add the following string to the PR description:

[skip changelog]

...and push a new commit to restart the check (git commit --allow-empty to create an empty commit).

This repository includes a script that aids in creating new changelog entries and compiling them into the final CHANGELOG.md file.

To see the list of commands and their options, run:

bin/changelog
bin/changelog <command> --help

All commands take command line parameters in addition to being interactive. See --help of the individual commands for more info.

To add a new changelog entry, use the entry command:

bin/changelog entry

This will create a new .json file in this directory. You don't need to modify CHANGELOG.md for the entry to be considered valid.

When a new version is ought to be released, the .changelogs/*.json files must be compiled into the human-readable CHANGELOG.md file.

To do that, use the consume command:

bin/changelog consume

This command "consumes" all changelog entries, asserts that they're all valid, formats them, and inserts the result into CHANGELOG.md. It also deletes all existing .changelogs/*.json files.

It is side-effect free (as in it does nothing outside of your local copy of this repository), to undo just checkout the old versions of .changelogs and CHANGELOG.md.