You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
matrix-spec/changelogs
Travis Ralston 8f2e8f03d0
Normalize changelog entries (#3476)
* Remove entries which don't affect the rendered spec (sorry people using the swagger schemas - we'll have to figure out a changelog for you). See https://github.com/matrix-org/matrix-doc/issues/3475
  * Note that a breaking change is removed by this commit: key backup was introduced in this release cycle, so is not breaking.
* Use uniform references to MSCs ("as per MSC0000").
* General rewording to be consistent with the overall voice of the changelog.
* Condensing of entries where needed to make them fit in the changelog.
* Rewording to collapse entries into fewer lines.
* Spell "deprecation" correctly in file extension.
4 years ago
..
application_service/newsfragments Release process: changelog generation and docs (#3446) 4 years ago
client_server/newsfragments Normalize changelog entries (#3476) 4 years ago
identity_service/newsfragments Update identity server spec to use global versioning (#3459) 4 years ago
legacy Release process: changelog generation and docs (#3446) 4 years ago
push_gateway/newsfragments Release process: changelog generation and docs (#3446) 4 years ago
server_server/newsfragments Normalize changelog entries (#3476) 4 years ago
README.md Release process: changelog generation and docs (#3446) 4 years ago
header.md Release process: changelog generation and docs (#3446) 4 years ago
pyproject.toml Release process: changelog generation and docs (#3446) 4 years ago

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.