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 56532dd688
Describe and hoist stripped state to a first-class citizen (#3606)
* Describe and hoist stripped state to a first-class citizen

Fixes https://github.com/matrix-org/matrix-doc/issues/3413
MSC: https://github.com/matrix-org/matrix-doc/pull/3173

* Add changelog

* may->can for clarity

* Update text per review
3 years ago
..
appendices/newsfragments Add a changelog for the appendices (#3609) 3 years ago
application_service/newsfragments v1.1 changelog 3 years ago
client_server/newsfragments Describe and hoist stripped state to a first-class citizen (#3606) 3 years ago
identity_service/newsfragments v1.1 changelog 3 years ago
legacy Add GitHub Action to check spelling (#3591) 3 years ago
push_gateway/newsfragments v1.1 changelog 3 years ago
room_versions/newsfragments Remove C-S `unsigned` data from PDU definitions (#3522) 3 years ago
server_server/newsfragments Clarification for `/event_auth` (#3583) 3 years ago
README.md Release process: changelog generation and docs (#3446) 3 years ago
header.md Release process: changelog generation and docs (#3446) 3 years ago
pyproject.toml Release process: changelog generation and docs (#3446) 3 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.