docs-matrix-spec/changelogs
Kévin Commaille 2678370f2c
Simplify uses of resolve-refs partial (#1773)
* Use the resolve-refs partial as soon as possible

Call it right after accessing the site.Data,
since it is recursing it will solve all references in the tree.
That way we don't need to wonder where to call it,
we trust the validators that the refs will be used in the right place.

* Enable strict $ref rule in OpenAPI validator

* Document use of $ref to compose examples

* Fix schema path in event-fields shortcode

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-04-09 18:06:53 +01:00
..
appendices/newsfragments Matrix 1.9 2023-11-29 10:05:20 -07:00
application_service/newsfragments Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
client_server/newsfragments Remove enum for POST /login type definition (#1776) 2024-04-09 17:27:26 +01:00
identity_service/newsfragments Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
internal/newsfragments Simplify uses of resolve-refs partial (#1773) 2024-04-09 18:06:53 +01:00
legacy Add a hyphen between third and party when used as an adjective (#1447) 2023-03-08 09:58:29 +00:00
push_gateway/newsfragments Matrix 1.6 2023-02-14 08:26:14 -07:00
room_versions/newsfragments Matrix 1.10 2024-03-22 10:00:27 -06:00
server_server/newsfragments Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
header.md Fix broken links to matrix-doc (#1032) 2022-04-20 16:36:14 +01:00
pyproject.toml Fix rendered changelog with new version of towncrier (#1598) 2023-07-18 17:52:38 +01:00
README.md Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
template.md.jinja Fix rendered changelog with new version of towncrier (#1598) 2023-07-18 17:52:38 +01: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.