From 45e47e91a0434180f1f5405f3ac3512a67c3f9aa Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Mon, 9 Sep 2024 09:10:52 +0200 Subject: [PATCH] Redirect /changelogs to latest version and adapt heading levels --- changelogs/header.md | 2 - changelogs/template.md.jinja | 2 +- content/changelog/_index.md | 40 ---------------- content/changelog/historical.md | 48 +++++++++++++++++++ content/changelog/v1.1.md | 12 ++--- content/changelog/v1.10.md | 18 ++++--- content/changelog/v1.11.md | 18 ++++--- content/changelog/v1.2.md | 16 +++---- content/changelog/v1.3.md | 16 +++---- content/changelog/v1.4.md | 18 ++++--- content/changelog/v1.5.md | 18 ++++--- content/changelog/v1.6.md | 18 ++++--- content/changelog/v1.7.md | 18 ++++--- content/changelog/v1.8.md | 18 ++++--- content/changelog/v1.9.md | 18 ++++--- .../changelog/changelog-description.html | 19 -------- layouts/shortcodes/changelog/changelogs.html | 8 ++-- scripts/generate-changelog.sh | 4 +- 18 files changed, 137 insertions(+), 174 deletions(-) create mode 100644 content/changelog/historical.md delete mode 100644 layouts/shortcodes/changelog/changelog-description.html diff --git a/changelogs/header.md b/changelogs/header.md index 26e7a9f4d..a8fd04ba3 100644 --- a/changelogs/header.md +++ b/changelogs/header.md @@ -6,8 +6,6 @@ Variables: DATE = Replaced by the date (eg: April 01, 2021) --> -## VERSION - diff --git a/changelogs/template.md.jinja b/changelogs/template.md.jinja index 38de4b921..cc456efd2 100644 --- a/changelogs/template.md.jinja +++ b/changelogs/template.md.jinja @@ -1,7 +1,7 @@ {% for section_name, section in sections.items() %} {% if section_name %} -### {{section_name}} +## {{section_name}} {% endif %} {% if section %} diff --git a/content/changelog/_index.md b/content/changelog/_index.md index 560cb43b0..ccb55f6fd 100644 --- a/content/changelog/_index.md +++ b/content/changelog/_index.md @@ -4,44 +4,4 @@ type: docs weight: 1000 --- -{{% changelog/changelog-description %}} - {{% changelog/changelogs %}} - -

Historical versions

- -Before version 1.1, versioning was applied at the level of individual API specifications. This section includes links to these versions of the APIs. - -* **Client-Server API** - - [r0.6.1](https://matrix.org/docs/spec/client_server/r0.6.1.html) - - [r0.6.0](https://matrix.org/docs/spec/client_server/r0.6.0.html) - - [r0.5.0](https://matrix.org/docs/spec/client_server/r0.5.0.html) - - [r0.4.0](https://matrix.org/docs/spec/client_server/r0.4.0.html) - - [r0.3.0](https://matrix.org/docs/spec/client_server/r0.3.0.html) - - [r0.2.0](https://matrix.org/docs/spec/client_server/r0.2.0.html) - - [r0.1.0](https://matrix.org/docs/spec/client_server/r0.1.0.html) - - [r0.0.1](https://matrix.org/docs/spec/r0.0.1/client_server.html) - - [r0.0.0](https://matrix.org/docs/spec/r0.0.0/client_server.html) - - [Legacy](https://matrix.org/docs/spec/legacy/#client-server-api): - The last draft before the spec was formally released in version - r0.0.0. - -* **Server-Server API** - - [r0.1.4](https://matrix.org/docs/spec/server_server/r0.1.4.html) - - [r0.1.3](https://matrix.org/docs/spec/server_server/r0.1.3.html) - - [r0.1.2](https://matrix.org/docs/spec/server_server/r0.1.2.html) - - [r0.1.1](https://matrix.org/docs/spec/server_server/r0.1.1.html) - - [r0.1.0](https://matrix.org/docs/spec/server_server/r0.1.0.html) - -* **Application Service API** - - [r0.1.1](https://matrix.org/docs/spec/application_service/r0.1.1.html) - - [r0.1.0](https://matrix.org/docs/spec/application_service/r0.1.0.html) - -* **Identity Service API** - - [r0.3.0](https://matrix.org/docs/spec/identity_service/r0.3.0.html) - - [r0.2.1](https://matrix.org/docs/spec/identity_service/r0.2.1.html) - - [r0.2.0](https://matrix.org/docs/spec/identity_service/r0.2.0.html) - - [r0.1.0](https://matrix.org/docs/spec/identity_service/r0.1.0.html) - -* **Push Gateway API** - - [r0.1.0](https://matrix.org/docs/spec/push_gateway/r0.1.0.html) diff --git a/content/changelog/historical.md b/content/changelog/historical.md new file mode 100644 index 000000000..72f1d9a2a --- /dev/null +++ b/content/changelog/historical.md @@ -0,0 +1,48 @@ +--- +title: Historical versions +type: docs +outputs: + - html +--- + +Before version 1.1, versioning was applied at the level of individual API specifications. +This section includes links to these versions of the APIs. + +## Client-Server API + + - [r0.6.1](https://matrix.org/docs/spec/client_server/r0.6.1.html) + - [r0.6.0](https://matrix.org/docs/spec/client_server/r0.6.0.html) + - [r0.5.0](https://matrix.org/docs/spec/client_server/r0.5.0.html) + - [r0.4.0](https://matrix.org/docs/spec/client_server/r0.4.0.html) + - [r0.3.0](https://matrix.org/docs/spec/client_server/r0.3.0.html) + - [r0.2.0](https://matrix.org/docs/spec/client_server/r0.2.0.html) + - [r0.1.0](https://matrix.org/docs/spec/client_server/r0.1.0.html) + - [r0.0.1](https://matrix.org/docs/spec/r0.0.1/client_server.html) + - [r0.0.0](https://matrix.org/docs/spec/r0.0.0/client_server.html) + - [Legacy](https://matrix.org/docs/spec/legacy/#client-server-api): + The last draft before the spec was formally released in version + r0.0.0. + +## Server-Server API + + - [r0.1.4](https://matrix.org/docs/spec/server_server/r0.1.4.html) + - [r0.1.3](https://matrix.org/docs/spec/server_server/r0.1.3.html) + - [r0.1.2](https://matrix.org/docs/spec/server_server/r0.1.2.html) + - [r0.1.1](https://matrix.org/docs/spec/server_server/r0.1.1.html) + - [r0.1.0](https://matrix.org/docs/spec/server_server/r0.1.0.html) + +## Application Service API + + - [r0.1.1](https://matrix.org/docs/spec/application_service/r0.1.1.html) + - [r0.1.0](https://matrix.org/docs/spec/application_service/r0.1.0.html) + +## Identity Service API + + - [r0.3.0](https://matrix.org/docs/spec/identity_service/r0.3.0.html) + - [r0.2.1](https://matrix.org/docs/spec/identity_service/r0.2.1.html) + - [r0.2.0](https://matrix.org/docs/spec/identity_service/r0.2.0.html) + - [r0.1.0](https://matrix.org/docs/spec/identity_service/r0.1.0.html) + +## Push Gateway API + + - [r0.1.0](https://matrix.org/docs/spec/push_gateway/r0.1.0.html) diff --git a/content/changelog/v1.1.md b/content/changelog/v1.1.md index ea5aea079..9b6a86fb1 100644 --- a/content/changelog/v1.1.md +++ b/content/changelog/v1.1.md @@ -14,8 +14,6 @@ Variables: November 09, 2021 = Replaced by the date (eg: April 01, 2021) --> -## v1.1 -
Git commithttps://github.com/matrix-org/matrix-spec/tree/VERSION
Release dateDATE
@@ -23,7 +21,7 @@ Variables:
Git commithttps://github.com/matrix-org/matrix-doc/tree/v1.1
Release dateNovember 09, 2021
-### Client-Server API +## Client-Server API Breaking Changes @@ -116,7 +114,7 @@ Variables: - Fix documentation errors around `threepid_creds`. ([#3471](https://github.com/matrix-org/matrix-doc/issues/3471)) -### Server-Server API +## Server-Server API New Endpoints @@ -142,7 +140,7 @@ Variables: - Tweak the example PDU diagram to better demonstrate situations with multiple `prev_events`. ([#3340](https://github.com/matrix-org/matrix-doc/issues/3340)) -### Application Service API +## Application Service API Spec Clarifications @@ -151,7 +149,7 @@ Variables: - Fix various typos throughout the specification. ([#2888](https://github.com/matrix-org/matrix-doc/issues/2888)) -### Identity Service API +## Identity Service API New Endpoints @@ -174,7 +172,7 @@ Variables: - Describe how [MSC2844](https://github.com/matrix-org/matrix-doc/pull/2844) affects the `/versions` endpoint. ([#3459](https://github.com/matrix-org/matrix-doc/issues/3459)) -### Push Gateway API +## Push Gateway API Spec Clarifications diff --git a/content/changelog/v1.10.md b/content/changelog/v1.10.md index e30ea93be..4db9349ed 100644 --- a/content/changelog/v1.10.md +++ b/content/changelog/v1.10.md @@ -14,8 +14,6 @@ Variables: March 22, 2024 = Replaced by the date (eg: April 01, 2021) --> -## v1.10 - @@ -24,7 +22,7 @@ Variables: -### Client-Server API +## Client-Server API **Backwards Compatible Changes** @@ -56,7 +54,7 @@ Variables: - Clarify that the `m.push_rules` account data type cannot be set using the `/account_data` API, as per [MSC4010](https://github.com/matrix-org/matrix-spec-proposals/pull/4010). ([#1763](https://github.com/matrix-org/matrix-spec/issues/1763)) -### Server-Server API +## Server-Server API **Spec Clarifications** @@ -65,36 +63,36 @@ Variables: - Clarify that the `children_state`, `room_type` and `allowed_room_ids` properties in the items of the `children` array of the response of the `GET /hierarchy` endpoint are not required. ([#1741](https://github.com/matrix-org/matrix-spec/issues/1741)) -### Application Service API +## Application Service API **Spec Clarifications** - Clarify that the `/login` and `/register` endpoints should fail when using the `m.login.application_service` login type without a valid `as_token`. ([#1744](https://github.com/matrix-org/matrix-spec/issues/1744)) -### Identity Service API +## Identity Service API No significant changes. -### Push Gateway API +## Push Gateway API No significant changes. -### Room Versions +## Room Versions **Spec Clarifications** - For room versions 7 through 11: Clarify that `invite->knock` is not a legal transition. ([#1717](https://github.com/matrix-org/matrix-spec/issues/1717)) -### Appendices +## Appendices No significant changes. -### Internal Changes/Tooling +## Internal Changes/Tooling **Spec Clarifications** diff --git a/content/changelog/v1.11.md b/content/changelog/v1.11.md index c9a880b5a..236fc8370 100644 --- a/content/changelog/v1.11.md +++ b/content/changelog/v1.11.md @@ -14,8 +14,6 @@ Variables: June 20, 2024 = Replaced by the date (eg: April 01, 2021) --> -## v1.11 -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.10
Release dateMarch 22, 2024
@@ -24,7 +22,7 @@ Variables: -### Client-Server API +## Client-Server API **Deprecations** @@ -69,7 +67,7 @@ Variables: - Clarify that `/media/v3/upload/{serverName}/{mediaId}` requires authentication. ([#1872](https://github.com/matrix-org/matrix-spec/issues/1872)) -### Server-Server API +## Server-Server API **Deprecations** @@ -93,26 +91,26 @@ Variables: - Fix various typos throughout the specification. ([#1877](https://github.com/matrix-org/matrix-spec/issues/1877)) -### Application Service API +## Application Service API **Spec Clarifications** - Clarify that appservices should be notified of events relating to the `sender_localpart` user. ([#1810](https://github.com/matrix-org/matrix-spec/issues/1810)) -### Identity Service API +## Identity Service API **Deprecations** - Authentication using a query string is now deprecated, as per [MSC4126](https://github.com/matrix-org/matrix-spec-proposals/issues/4126). The `Authorization` header should be used instead. ([#1808](https://github.com/matrix-org/matrix-spec/issues/1808)) -### Push Gateway API +## Push Gateway API No significant changes. -### Room Versions +## Room Versions **Spec Clarifications** @@ -122,7 +120,7 @@ No significant changes. - Generate the Table of Contents with Hugo rather than JavaScript. ([#1884](https://github.com/matrix-org/matrix-spec/issues/1884)) -### Appendices +## Appendices **Deprecations** @@ -135,7 +133,7 @@ No significant changes. - Move size limits for user, room and event IDs into the appendix and clarify that the length is to be measured in bytes. ([#1850](https://github.com/matrix-org/matrix-spec/issues/1850)) -### Internal Changes/Tooling +## Internal Changes/Tooling **Spec Clarifications** diff --git a/content/changelog/v1.2.md b/content/changelog/v1.2.md index 39cfb18af..e2e8ed096 100644 --- a/content/changelog/v1.2.md +++ b/content/changelog/v1.2.md @@ -14,8 +14,6 @@ Variables: February 02, 2022 = Replaced by the date (eg: April 01, 2021) --> -## v1.2 -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.11
Release dateJune 20, 2024
@@ -23,7 +21,7 @@ Variables:
Git commithttps://github.com/matrix-org/matrix-doc/tree/v1.2
Release dateFebruary 02, 2022
-### Client-Server API +## Client-Server API Breaking Changes @@ -71,7 +69,7 @@ Variables: - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674)) -### Server-Server API +## Server-Server API New Endpoints @@ -94,7 +92,7 @@ Variables: - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674)) -### Application Service API +## Application Service API Spec Clarifications @@ -105,7 +103,7 @@ Variables: - Correct the documentation for the response value for `GET /_matrix/app/v1/thirdparty/protocol/{protocol}`. ([#3675](https://github.com/matrix-org/matrix-doc/issues/3675)) -### Identity Service API +## Identity Service API Backwards Compatible Changes @@ -120,7 +118,7 @@ Variables: - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674)) -### Push Gateway API +## Push Gateway API Spec Clarifications @@ -129,7 +127,7 @@ Variables: - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674)) -### Room Versions +## Room Versions Backwards Compatible Changes @@ -150,7 +148,7 @@ Variables: - Fix auth rules to allow membership of `knock` -> `leave` in v7, v8, and v9. ([#3694](https://github.com/matrix-org/matrix-doc/issues/3694)) -### Appendices +## Appendices Backwards Compatible Changes diff --git a/content/changelog/v1.3.md b/content/changelog/v1.3.md index 31d65225f..77fe4717f 100644 --- a/content/changelog/v1.3.md +++ b/content/changelog/v1.3.md @@ -14,8 +14,6 @@ Variables: June 15, 2022 = Replaced by the date (eg: April 01, 2021) --> -## v1.3 - @@ -23,7 +21,7 @@ Variables:
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.3
Release dateJune 15, 2022
-### Client-Server API +## Client-Server API Deprecations @@ -61,7 +59,7 @@ Variables: - Fix membership state transitions to denote that `invite->knock` and `external->leave` are valid transitions. ([#3730](https://github.com/matrix-org/matrix-spec-proposals/issues/3730)) -### Server-Server API +## Server-Server API Backwards Compatible Changes @@ -85,7 +83,7 @@ Variables: - Clarify that the `content` for `X-Matrix` signature validation is the parsed JSON body. ([#3727](https://github.com/matrix-org/matrix-spec-proposals/issues/3727)) -### Application Service API +## Application Service API Backwards Compatible Changes @@ -94,19 +92,19 @@ Variables: - Add timestamp massaging as per [MSC3316](https://github.com/matrix-org/matrix-spec-proposals/pull/3316). ([#1094](https://github.com/matrix-org/matrix-spec/issues/1094)) -### Identity Service API +## Identity Service API No significant changes. -### Push Gateway API +## Push Gateway API No significant changes. -### Room Versions +## Room Versions Backwards Compatible Changes @@ -130,7 +128,7 @@ No significant changes. - For room versions 7, 8, 9, and 10: fix join membership authorization rules when `join_rule` is `knock`. ([#3737](https://github.com/matrix-org/matrix-spec-proposals/issues/3737)) -### Appendices +## Appendices No significant changes. diff --git a/content/changelog/v1.4.md b/content/changelog/v1.4.md index 9148cf2cd..c713611e4 100644 --- a/content/changelog/v1.4.md +++ b/content/changelog/v1.4.md @@ -14,8 +14,6 @@ Variables: September 29, 2022 = Replaced by the date (eg: April 01, 2021) --> -## v1.4 - @@ -23,7 +21,7 @@ Variables:
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.4
Release dateSeptember 29, 2022
-### Client-Server API +## Client-Server API Removed Endpoints @@ -64,7 +62,7 @@ Variables: - Clarify enum values by separating possible values with commas. ([#1240](https://github.com/matrix-org/matrix-spec/issues/1240)) -### Server-Server API +## Server-Server API Backwards Compatible Changes @@ -81,7 +79,7 @@ Variables: - Update "API Standards" section to clarify how JSON is used. ([#1185](https://github.com/matrix-org/matrix-spec/issues/1185)) -### Application Service API +## Application Service API Breaking Changes @@ -96,7 +94,7 @@ Variables: - Add HTML anchors for object definitions in the formatted specification. ([#1174](https://github.com/matrix-org/matrix-spec/issues/1174)) -### Identity Service API +## Identity Service API Spec Clarifications @@ -106,7 +104,7 @@ Variables: - Update "API Standards" section to clarify how JSON is used. ([#1185](https://github.com/matrix-org/matrix-spec/issues/1185)) -### Push Gateway API +## Push Gateway API Spec Clarifications @@ -115,7 +113,7 @@ Variables: - Add HTML anchors for object definitions in the formatted specification. ([#1174](https://github.com/matrix-org/matrix-spec/issues/1174)) -### Room Versions +## Room Versions Spec Clarifications @@ -126,13 +124,13 @@ Variables: - For room versions 7 through 10: Clarify that `invite->knock` is actually a legal transition. ([#1175](https://github.com/matrix-org/matrix-spec/issues/1175)) -### Appendices +## Appendices No significant changes. -### Internal Changes/Tooling +## Internal Changes/Tooling Backwards Compatible Changes diff --git a/content/changelog/v1.5.md b/content/changelog/v1.5.md index ad258717e..1465090ac 100644 --- a/content/changelog/v1.5.md +++ b/content/changelog/v1.5.md @@ -14,8 +14,6 @@ Variables: November 17, 2022 = Replaced by the date (eg: April 01, 2021) --> -## v1.5 - @@ -23,7 +21,7 @@ Variables:
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.5
Release dateNovember 17, 2022
-### Client-Server API +## Client-Server API Backwards Compatible Changes @@ -51,7 +49,7 @@ Variables: - Add example read receipt to `GET /_matrix/client/v3/sync` response example. ([#1341](https://github.com/matrix-org/matrix-spec/issues/1341)) -### Server-Server API +## Server-Server API Spec Clarifications @@ -60,7 +58,7 @@ Variables: - Fix a number of broken links in the specification. ([#1330](https://github.com/matrix-org/matrix-spec/issues/1330)) -### Application Service API +## Application Service API Spec Clarifications @@ -69,7 +67,7 @@ Variables: - Clarify that application services can only register an interest in local users, as per [MSC3905](https://github.com/matrix-org/matrix-spec-proposals/issues/3905). ([#1305](https://github.com/matrix-org/matrix-spec/issues/1305)) -### Identity Service API +## Identity Service API Spec Clarifications @@ -78,13 +76,13 @@ Variables: - Fix a number of broken links in the specification. ([#1330](https://github.com/matrix-org/matrix-spec/issues/1330)) -### Push Gateway API +## Push Gateway API No significant changes. -### Room Versions +## Room Versions Spec Clarifications @@ -95,13 +93,13 @@ No significant changes. - Fix a number of broken links in the specification. ([#1330](https://github.com/matrix-org/matrix-spec/issues/1330)) -### Appendices +## Appendices No significant changes. -### Internal Changes/Tooling +## Internal Changes/Tooling Backwards Compatible Changes diff --git a/content/changelog/v1.6.md b/content/changelog/v1.6.md index 08163fc5f..cde90ea7f 100644 --- a/content/changelog/v1.6.md +++ b/content/changelog/v1.6.md @@ -14,8 +14,6 @@ Variables: February 14, 2023 = Replaced by the date (eg: April 01, 2021) --> -## v1.6 - @@ -23,7 +21,7 @@ Variables:
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.6
Release dateFebruary 14, 2023
-### Client-Server API +## Client-Server API Backwards Compatible Changes @@ -51,7 +49,7 @@ Variables: - Improve distinction between tags and their attributes in the rich text section. Contributed by Nico. ([#1433](https://github.com/matrix-org/matrix-spec/issues/1433)) -### Server-Server API +## Server-Server API Breaking Changes @@ -79,7 +77,7 @@ Variables: - Fix `edu_type` in EDU examples. ([#1383](https://github.com/matrix-org/matrix-spec/issues/1383)) -### Application Service API +## Application Service API Backwards Compatible Changes @@ -88,7 +86,7 @@ Variables: - Add information on standard error responses for unknown endpoints/methods, as per [MSC3743](https://github.com/matrix-org/matrix-spec-proposals/pull/3743). ([#1347](https://github.com/matrix-org/matrix-spec/issues/1347)) -### Identity Service API +## Identity Service API Backwards Compatible Changes @@ -97,7 +95,7 @@ Variables: - Add information on standard error responses for unknown endpoints/methods, as per [MSC3743](https://github.com/matrix-org/matrix-spec-proposals/pull/3743). ([#1347](https://github.com/matrix-org/matrix-spec/issues/1347)) -### Push Gateway API +## Push Gateway API Backwards Compatible Changes @@ -106,7 +104,7 @@ Variables: - Add information on standard error responses for unknown endpoints/methods, as per [MSC3743](https://github.com/matrix-org/matrix-spec-proposals/pull/3743). ([#1347](https://github.com/matrix-org/matrix-spec/issues/1347)) -### Room Versions +## Room Versions Backwards Compatible Changes @@ -122,13 +120,13 @@ Variables: - Fix various typos throughout the specification. ([#1423](https://github.com/matrix-org/matrix-spec/issues/1423)) -### Appendices +## Appendices No significant changes. -### Internal Changes/Tooling +## Internal Changes/Tooling Spec Clarifications diff --git a/content/changelog/v1.7.md b/content/changelog/v1.7.md index 028f24aef..e4ee8bc17 100644 --- a/content/changelog/v1.7.md +++ b/content/changelog/v1.7.md @@ -14,8 +14,6 @@ Variables: May 25, 2023 = Replaced by the date (eg: April 01, 2021) --> -## v1.7 - @@ -23,7 +21,7 @@ Variables:
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.7
Release dateMay 25, 2023
-### Client-Server API +## Client-Server API New Endpoints @@ -69,7 +67,7 @@ Variables: - Add missing `knock_restricted` join rule to the `m.room.join_rules` schema. ([#1535](https://github.com/matrix-org/matrix-spec/issues/1535)) -### Server-Server API +## Server-Server API Spec Clarifications @@ -81,7 +79,7 @@ Variables: - Remove extraneous `age_ts` field from the reference hash calculation section. ([#1536](https://github.com/matrix-org/matrix-spec/issues/1536)) -### Application Service API +## Application Service API New Endpoints @@ -103,7 +101,7 @@ Variables: - Fix various typos throughout the specification. ([#1447](https://github.com/matrix-org/matrix-spec/issues/1447)) -### Identity Service API +## Identity Service API Spec Clarifications @@ -112,13 +110,13 @@ Variables: - Corrections to the response format of `/_matrix/identity/v2/store-invite`. ([#1486](https://github.com/matrix-org/matrix-spec/issues/1486)) -### Push Gateway API +## Push Gateway API No significant changes. -### Room Versions +## Room Versions Spec Clarifications @@ -127,7 +125,7 @@ No significant changes. - Clarifications of event ID formats in early room versions ([#1484](https://github.com/matrix-org/matrix-spec/issues/1484)) -### Appendices +## Appendices Spec Clarifications @@ -138,7 +136,7 @@ No significant changes. - Clarifications of event ID formats in early room versions. ([#1484](https://github.com/matrix-org/matrix-spec/issues/1484)) -### Internal Changes/Tooling +## Internal Changes/Tooling Spec Clarifications diff --git a/content/changelog/v1.8.md b/content/changelog/v1.8.md index 7925a8b47..8da89f930 100644 --- a/content/changelog/v1.8.md +++ b/content/changelog/v1.8.md @@ -14,8 +14,6 @@ Variables: August 23, 2023 = Replaced by the date (eg: April 01, 2021) --> -## v1.8 - @@ -24,7 +22,7 @@ Variables: -### Client-Server API +## Client-Server API **Backwards Compatible Changes** @@ -42,7 +40,7 @@ Variables: - Fix various typos throughout the specification. ([#1597](https://github.com/matrix-org/matrix-spec/issues/1597)) -### Server-Server API +## Server-Server API **Deprecations** @@ -64,26 +62,26 @@ Variables: - Switch to ordered list for server name resolution steps. ([#1623](https://github.com/matrix-org/matrix-spec/issues/1623)) -### Application Service API +## Application Service API **Spec Clarifications** - Fix type of custom `fields` in thirdparty lookup queries. ([#1584](https://github.com/matrix-org/matrix-spec/issues/1584)) -### Identity Service API +## Identity Service API **Spec Clarifications** - Make sure examples types match schema in definitions. ([#1563](https://github.com/matrix-org/matrix-spec/issues/1563)) -### Push Gateway API +## Push Gateway API No significant changes. -### Room Versions +## Room Versions **Backwards Compatible Changes** @@ -94,7 +92,7 @@ No significant changes. - Update the redaction rules in room version 11, as per [MSC2176](https://github.com/matrix-org/matrix-spec-proposals/pull/2176) and [MSC3821](https://github.com/matrix-org/matrix-spec-proposals/pull/3821). ([#1604](https://github.com/matrix-org/matrix-spec/issues/1604)) -### Appendices +## Appendices **Backwards Compatible Changes** @@ -105,7 +103,7 @@ No significant changes. - Clarify spec re canonical JSON to handle negative-zero; also, give an example of negative-zero and a large power of ten. ([#1573](https://github.com/matrix-org/matrix-spec/issues/1573)) -### Internal Changes/Tooling +## Internal Changes/Tooling **Backwards Compatible Changes** diff --git a/content/changelog/v1.9.md b/content/changelog/v1.9.md index 021343199..497bb3a91 100644 --- a/content/changelog/v1.9.md +++ b/content/changelog/v1.9.md @@ -14,8 +14,6 @@ Variables: November 29, 2023 = Replaced by the date (eg: April 01, 2021) --> -## v1.9 -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.8
Release dateAugust 23, 2023
@@ -24,7 +22,7 @@ Variables: -### Client-Server API +## Client-Server API **Backwards Compatible Changes** @@ -44,7 +42,7 @@ Variables: - Clarify that thread roots are not considered within the thread. ([#1677](https://github.com/matrix-org/matrix-spec/issues/1677)) -### Server-Server API +## Server-Server API **Spec Clarifications** @@ -53,27 +51,27 @@ Variables: - Clarify that federation requests for non-local users are invalid. ([#1672](https://github.com/matrix-org/matrix-spec/issues/1672)) -### Application Service API +## Application Service API No significant changes. -### Identity Service API +## Identity Service API No significant changes. -### Push Gateway API +## Push Gateway API No significant changes. -### Room Versions +## Room Versions No significant changes. -### Appendices +## Appendices **Spec Clarifications** @@ -81,7 +79,7 @@ No significant changes. - Fix various typos throughout the specification. ([#1652](https://github.com/matrix-org/matrix-spec/issues/1652)) -### Internal Changes/Tooling +## Internal Changes/Tooling **Backwards Compatible Changes** diff --git a/layouts/shortcodes/changelog/changelog-description.html b/layouts/shortcodes/changelog/changelog-description.html deleted file mode 100644 index 3c7197252..000000000 --- a/layouts/shortcodes/changelog/changelog-description.html +++ /dev/null @@ -1,19 +0,0 @@ -{{/* - - This template is used to provide different content for the unstable spec - version and for a versioned release. - -*/}} - -{{ $status := .Site.Params.version.status }} - -{{ if eq $status "unstable"}} - -

This is the unstable version of the Matrix specification.

-

This changelog lists changes made since the last release of the specification.

- -{{ else }} - -

This is version v{{ .Site.Params.version.major }}.{{ .Site.Params.version.minor }} of the Matrix specification.

- -{{ end }} diff --git a/layouts/shortcodes/changelog/changelogs.html b/layouts/shortcodes/changelog/changelogs.html index f040cea8b..2c201a1b6 100644 --- a/layouts/shortcodes/changelog/changelogs.html +++ b/layouts/shortcodes/changelog/changelogs.html @@ -1,8 +1,8 @@ {{/* - This template is used to render all of the changelog sections under - "content/changelogs" + This template is used to redirect the changelog section under + "content/changelogs" to the latest version's changelog page. */}} -{{ range .Page.RegularPages }} -{{ .RenderShortcodes }} +{{ with index .Page.RegularPages.ByDate.Reverse 0 }} + {{ end }} diff --git a/scripts/generate-changelog.sh b/scripts/generate-changelog.sh index bad6f73e7..b91e63cf3 100755 --- a/scripts/generate-changelog.sh +++ b/scripts/generate-changelog.sh @@ -30,9 +30,7 @@ outputs: date: $(date -Iseconds) --- EOF - if [ "$VERSION" = "vUNSTABLE" ]; then - echo "## Changes since last release" - else + if [ "$VERSION" != "vUNSTABLE" ]; then sed -e "s/VERSION/$1/g" -e "s/DATE/$2/g" header.md fi
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.9
Release dateNovember 29, 2023