2018-07-07 01:06:08 +02:00
|
|
|
# Changelogs
|
|
|
|
|
|
2020-03-24 18:29:00 +01:00
|
|
|
[Towncrier](https://github.com/hawkowl/towncrier) is used to manage the changelog and
|
2018-07-07 01:06:08 +02:00
|
|
|
keep it up to date. Because of this, updating a changelog is really easy.
|
|
|
|
|
|
2021-10-18 18:09:35 +02:00
|
|
|
## Generating the changelog
|
2020-03-24 18:29:00 +01:00
|
|
|
|
2021-10-18 18:09:35 +02:00
|
|
|
Please see the [release docs](../meta/releasing.md) for more information.
|
2020-03-24 18:29:00 +01:00
|
|
|
|
2021-10-18 18:09:35 +02:00
|
|
|
## Creating a new changelog
|
2020-03-24 18:29:00 +01:00
|
|
|
|
2021-10-18 18:09:35 +02:00
|
|
|
There are a few places you'll have to update:
|
|
|
|
|
* `/layouts/shortcodes/changelog/changelog-changes.html` to account for the new changelog.
|
|
|
|
|
* `/scripts/generate-changelog.sh` to render the changelog for releases.
|
|
|
|
|
* Supporting documentation such as the contributing guidelines.
|
