matrix-doc/changelogs
Travis Ralston e8674688e6
Release process: changelog generation and docs (#3446)
* Remove extra pyprojects and update changelog docs

* Add script for rendering the changelog

* Add docs for how to release the spec

* Move legacy changelogs out of the way
2021-10-18 10:09:35 -06:00
..
application_service/newsfragments Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
client_server/newsfragments Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
identity_service/newsfragments Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
legacy Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
push_gateway/newsfragments Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
server_server/newsfragments Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06: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.