History

Hubert Chathi 1ad5ff4179 Key name is supposed to be optional, as per MSC2874 (#3481 )		2021-11-10 13:48:18 -05:00
..
application_service/newsfragments	v1.1 changelog	2021-11-09 07:23:27 -07:00
client_server/newsfragments	Key name is supposed to be optional, as per MSC2874 (#3481 )	2021-11-10 13:48:18 -05:00
identity_service/newsfragments	v1.1 changelog	2021-11-09 07:23:27 -07:00
legacy	Release process: changelog generation and docs (#3446 )	2021-10-18 10:09:35 -06:00
push_gateway/newsfragments	v1.1 changelog	2021-11-09 07:23:27 -07:00
server_server/newsfragments	v1.1 changelog	2021-11-09 07:23:27 -07:00
README.md	Release process: changelog generation and docs (#3446 )	2021-10-18 10:09:35 -06:00
header.md	Release process: changelog generation and docs (#3446 )	2021-10-18 10:09:35 -06:00
pyproject.toml	Release process: changelog generation and docs (#3446 )	2021-10-18 10:09:35 -06:00

README.md

Changelogs

Towncrier is used to manage the changelog and keep it up to date. Because of this, updating a changelog is really easy.

Generating the changelog

Please see the release docs for more information.

Creating a new changelog

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.