matrix-spec/changelogs
Richard van der Hoff 36b02edfc2
Distinguish 'client' from 'federation' events (#3658)
Fixes #3305 
Fixes #3380
 
The idea here is to better distinguish between a 'raw' event (as we send over the wire), and the 
'serialised' format, as sent in responses to the C-S api and in `PUT /_matrix/app/v1/transactions/{txnId}`.

It's made more complicated by the fact that there are _two_ serialisation formats, one used by `/sync`
and `/notifications`, and one by everything else (the difference being whether `room_id` is included).

In an ideal world, we wouldn't repeat `SerialisedEvent` every time it's used, and instead just link to the
first reference, but that's a job for another day.

Another job for another day is to get rid of things like `sync_state_event.yaml` (which is now used
only in one place, so should be inlined.)
2022-02-01 15:05:08 +00:00
..
appendices/newsfragments Add a changelog for the appendices (#3609) 2022-01-04 20:23:02 -07:00
application_service/newsfragments Distinguish 'client' from 'federation' events (#3658) 2022-02-01 15:05:08 +00:00
client_server/newsfragments Distinguish 'client' from 'federation' events (#3658) 2022-02-01 15:05:08 +00:00
identity_service/newsfragments Changelogs for #3674 2022-01-26 11:00:30 +00:00
legacy Add GitHub Action to check spelling (#3591) 2021-12-28 09:17:49 -07:00
push_gateway/newsfragments Changelogs for #3674 2022-01-26 11:00:30 +00:00
room_versions/newsfragments Update documentation style & fix room version heading order (#3683) 2022-01-31 15:18:58 -07:00
server_server/newsfragments Changelogs for #3674 2022-01-26 11:00:30 +00: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 Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00

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.