Generate the changelog for a release

The changelog for each version of this library is part of the documentation. As such the following steps have to be manually executed prior to tagging a new release:

  1. If not already done, install jreleaser.

  2. Set export JRELEASER_PROJECT_VERSION=x.x.x

  3. Run tox -e generate-changelog. This will generate the changelog and append it to the top of the CHANGELOG.md file.

  4. Manually fill out the Highlights and Known Issues sections.

  5. Commit the new changelog.

Each version entry is designed in such a way, that the Details section list the autogenerated full changes while the Highlights and Known Issues sections contain summaries of what is relevant.