Building the Changelog#

The changelog is built from news fragments that are added to the repository. These fragments are collected and assembled into a changelog file for each new release.

To build the changelog, make sure you have:

  1. If needed, bump the version.

  2. Build the changelog file from all news fragments:

    Build a combined changelog from news fragments#
    towncrier build [--yes]

    After this command, the CHANGELOG.rst file in the root directory is updated and all news fragments are removed from the directory changelog.d/.

  3. Review the CHANGELOG.rst file. Sometimes the changelog may not look as expected, especially if the news fragments are not formatted correctly. You can edit the file manually to fix any issues.

  4. Commit the CHANGELOG.rst and the changelog.d/ directory with a message that describes the change.