mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-03 21:03:42 +01:00
08fde5f257
Replace the current stack of hugo templates with a towncrier invocation. The main advantage of this is that it means that the "Changes since last release" section is consistent with the changelogs for the actual releases. This also changes the release process so that the changelog is generated before tagging, which means that the thing tagged v1.5 is actually the v1.5 spec. Fixes #908. |
||
|---|---|---|
| .. | ||
| appendices/newsfragments | ||
| application_service/newsfragments | ||
| client_server/newsfragments | ||
| identity_service/newsfragments | ||
| internal/newsfragments | ||
| legacy | ||
| push_gateway/newsfragments | ||
| room_versions/newsfragments | ||
| server_server/newsfragments | ||
| header.md | ||
| pyproject.toml | ||
| 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.htmlto account for the new changelog./scripts/generate-changelog.shto render the changelog for releases.- Supporting documentation such as the contributing guidelines.