From 921c6becf1433042f5345d773ee152c1e69281fc Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 16 Dec 2024 13:38:04 -0700 Subject: [PATCH 1/6] Normalize changelog --- changelogs/client_server/newsfragments/1938.clarification | 2 +- changelogs/client_server/newsfragments/1938.new | 2 +- changelogs/client_server/newsfragments/1944.feature | 2 +- changelogs/client_server/newsfragments/2028.new | 2 +- changelogs/server_server/newsfragments/2004.feature | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/changelogs/client_server/newsfragments/1938.clarification b/changelogs/client_server/newsfragments/1938.clarification index 4bfd2a3c..c2ced145 100644 --- a/changelogs/client_server/newsfragments/1938.clarification +++ b/changelogs/client_server/newsfragments/1938.clarification @@ -1 +1 @@ -The `reason` parameter in `POST /_matrix/client/v3/rooms/{roomId}/report/{eventId}` can be omitted instead of left blank as per [MSC2414](https://github.com/matrix-org/matrix-spec-proposals/pull/2414). +The `reason` parameter in `POST /_matrix/client/v3/rooms/{roomId}/report/{eventId}` can be omitted instead of left blank, as per [MSC2414](https://github.com/matrix-org/matrix-spec-proposals/pull/2414). diff --git a/changelogs/client_server/newsfragments/1938.new b/changelogs/client_server/newsfragments/1938.new index 718ee755..62c23cd4 100644 --- a/changelogs/client_server/newsfragments/1938.new +++ b/changelogs/client_server/newsfragments/1938.new @@ -1 +1 @@ -Add `POST /_matrix/client/v3/rooms/{roomId}/report` as per [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151). +Add `POST /_matrix/client/v3/rooms/{roomId}/report`, as per [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151). diff --git a/changelogs/client_server/newsfragments/1944.feature b/changelogs/client_server/newsfragments/1944.feature index 9fab9bcc..916ab978 100644 --- a/changelogs/client_server/newsfragments/1944.feature +++ b/changelogs/client_server/newsfragments/1944.feature @@ -1 +1 @@ -Add error codes to requestToken endpoints (MSC4178). +Add error codes to requestToken endpoints, as per [MSC4178](https://github.com/matrix-org/matrix-spec-proposals/pull/4178). diff --git a/changelogs/client_server/newsfragments/2028.new b/changelogs/client_server/newsfragments/2028.new index 718ee755..62c23cd4 100644 --- a/changelogs/client_server/newsfragments/2028.new +++ b/changelogs/client_server/newsfragments/2028.new @@ -1 +1 @@ -Add `POST /_matrix/client/v3/rooms/{roomId}/report` as per [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151). +Add `POST /_matrix/client/v3/rooms/{roomId}/report`, as per [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151). diff --git a/changelogs/server_server/newsfragments/2004.feature b/changelogs/server_server/newsfragments/2004.feature index dd23b73d..73478c40 100644 --- a/changelogs/server_server/newsfragments/2004.feature +++ b/changelogs/server_server/newsfragments/2004.feature @@ -1 +1 @@ -Make ACLs apply to EDUs as per [MSC4163](https://github.com/matrix-org/matrix-spec-proposals/pull/4163). +Make ACLs apply to EDUs, as per [MSC4163](https://github.com/matrix-org/matrix-spec-proposals/pull/4163). From bc995e66d64b1376d0923333fce503dbf30a26c8 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Thu, 19 Dec 2024 09:22:53 -0700 Subject: [PATCH 2/6] v1.13 --- .../newsfragments/1966.clarification | 1 - .../newsfragments/2018.feature | 1 - .../newsfragments/1938.clarification | 1 - .../client_server/newsfragments/1938.new | 1 - .../client_server/newsfragments/1944.feature | 1 - .../newsfragments/1947.clarification | 1 - .../newsfragments/1967.clarification | 1 - .../newsfragments/1973.clarification | 1 - .../newsfragments/1978.clarification | 1 - .../newsfragments/1979.clarification | 1 - .../newsfragments/1980.clarification | 1 - .../newsfragments/1983.clarification | 1 - .../client_server/newsfragments/1994.feature | 1 - .../client_server/newsfragments/1995.feature | 1 - .../client_server/newsfragments/2011.feature | 1 - .../client_server/newsfragments/2014.feature | 1 - .../newsfragments/2015.clarification | 1 - .../newsfragments/2016.clarification | 1 - .../newsfragments/2017.clarification | 1 - .../client_server/newsfragments/2028.new | 1 - .../newsfragments/2029.clarification | 1 - .../internal/newsfragments/1967.clarification | 1 - .../internal/newsfragments/1969.clarification | 1 - .../internal/newsfragments/1970.clarification | 1 - .../internal/newsfragments/1971.clarification | 1 - .../internal/newsfragments/1972.clarification | 1 - .../internal/newsfragments/1975.clarification | 1 - .../internal/newsfragments/1976.clarification | 1 - .../internal/newsfragments/1977.clarification | 1 - .../internal/newsfragments/1984.clarification | 1 - .../internal/newsfragments/1985.clarification | 1 - .../internal/newsfragments/1991.clarification | 1 - .../internal/newsfragments/1996.clarification | 1 - .../internal/newsfragments/1997.clarification | 1 - .../internal/newsfragments/1999.clarification | 1 - .../internal/newsfragments/2000.clarification | 1 - .../internal/newsfragments/2001.clarification | 1 - .../internal/newsfragments/2002.clarification | 1 - .../internal/newsfragments/2003.clarification | 1 - .../internal/newsfragments/2005.clarification | 1 - .../internal/newsfragments/2006.clarification | 1 - .../internal/newsfragments/2007.clarification | 1 - .../internal/newsfragments/2008.clarification | 1 - .../internal/newsfragments/2009.clarification | 1 - .../internal/newsfragments/2021.clarification | 1 - .../internal/newsfragments/2022.clarification | 1 - .../newsfragments/1968.clarification | 1 - .../newsfragments/1974.clarification | 1 - .../newsfragments/2024.clarification | 1 - .../newsfragments/1926.clarification | 1 - .../server_server/newsfragments/2004.feature | 1 - config/_default/hugo.toml | 8 +- content/changelog/v1.13.md | 122 ++++++++++++++++++ 53 files changed, 126 insertions(+), 55 deletions(-) delete mode 100644 changelogs/appendices/newsfragments/1966.clarification delete mode 100644 changelogs/application_service/newsfragments/2018.feature delete mode 100644 changelogs/client_server/newsfragments/1938.clarification delete mode 100644 changelogs/client_server/newsfragments/1938.new delete mode 100644 changelogs/client_server/newsfragments/1944.feature delete mode 100644 changelogs/client_server/newsfragments/1947.clarification delete mode 100644 changelogs/client_server/newsfragments/1967.clarification delete mode 100644 changelogs/client_server/newsfragments/1973.clarification delete mode 100644 changelogs/client_server/newsfragments/1978.clarification delete mode 100644 changelogs/client_server/newsfragments/1979.clarification delete mode 100644 changelogs/client_server/newsfragments/1980.clarification delete mode 100644 changelogs/client_server/newsfragments/1983.clarification delete mode 100644 changelogs/client_server/newsfragments/1994.feature delete mode 100644 changelogs/client_server/newsfragments/1995.feature delete mode 100644 changelogs/client_server/newsfragments/2011.feature delete mode 100644 changelogs/client_server/newsfragments/2014.feature delete mode 100644 changelogs/client_server/newsfragments/2015.clarification delete mode 100644 changelogs/client_server/newsfragments/2016.clarification delete mode 100644 changelogs/client_server/newsfragments/2017.clarification delete mode 100644 changelogs/client_server/newsfragments/2028.new delete mode 100644 changelogs/client_server/newsfragments/2029.clarification delete mode 100644 changelogs/internal/newsfragments/1967.clarification delete mode 100644 changelogs/internal/newsfragments/1969.clarification delete mode 100644 changelogs/internal/newsfragments/1970.clarification delete mode 100644 changelogs/internal/newsfragments/1971.clarification delete mode 100644 changelogs/internal/newsfragments/1972.clarification delete mode 100644 changelogs/internal/newsfragments/1975.clarification delete mode 100644 changelogs/internal/newsfragments/1976.clarification delete mode 100644 changelogs/internal/newsfragments/1977.clarification delete mode 100644 changelogs/internal/newsfragments/1984.clarification delete mode 100644 changelogs/internal/newsfragments/1985.clarification delete mode 100644 changelogs/internal/newsfragments/1991.clarification delete mode 100644 changelogs/internal/newsfragments/1996.clarification delete mode 100644 changelogs/internal/newsfragments/1997.clarification delete mode 100644 changelogs/internal/newsfragments/1999.clarification delete mode 100644 changelogs/internal/newsfragments/2000.clarification delete mode 100644 changelogs/internal/newsfragments/2001.clarification delete mode 100644 changelogs/internal/newsfragments/2002.clarification delete mode 100644 changelogs/internal/newsfragments/2003.clarification delete mode 100644 changelogs/internal/newsfragments/2005.clarification delete mode 100644 changelogs/internal/newsfragments/2006.clarification delete mode 100644 changelogs/internal/newsfragments/2007.clarification delete mode 100644 changelogs/internal/newsfragments/2008.clarification delete mode 100644 changelogs/internal/newsfragments/2009.clarification delete mode 100644 changelogs/internal/newsfragments/2021.clarification delete mode 100644 changelogs/internal/newsfragments/2022.clarification delete mode 100644 changelogs/push_gateway/newsfragments/1968.clarification delete mode 100644 changelogs/push_gateway/newsfragments/1974.clarification delete mode 100644 changelogs/room_versions/newsfragments/2024.clarification delete mode 100644 changelogs/server_server/newsfragments/1926.clarification delete mode 100644 changelogs/server_server/newsfragments/2004.feature create mode 100644 content/changelog/v1.13.md diff --git a/changelogs/appendices/newsfragments/1966.clarification b/changelogs/appendices/newsfragments/1966.clarification deleted file mode 100644 index 362e2cac..00000000 --- a/changelogs/appendices/newsfragments/1966.clarification +++ /dev/null @@ -1 +0,0 @@ -Remove note about reference implementations. diff --git a/changelogs/application_service/newsfragments/2018.feature b/changelogs/application_service/newsfragments/2018.feature deleted file mode 100644 index 07d6e62a..00000000 --- a/changelogs/application_service/newsfragments/2018.feature +++ /dev/null @@ -1 +0,0 @@ -Allow sending ephemeral data to application services, as per [MSC2409](https://github.com/matrix-org/matrix-spec-proposals/pull/2409). diff --git a/changelogs/client_server/newsfragments/1938.clarification b/changelogs/client_server/newsfragments/1938.clarification deleted file mode 100644 index c2ced145..00000000 --- a/changelogs/client_server/newsfragments/1938.clarification +++ /dev/null @@ -1 +0,0 @@ -The `reason` parameter in `POST /_matrix/client/v3/rooms/{roomId}/report/{eventId}` can be omitted instead of left blank, as per [MSC2414](https://github.com/matrix-org/matrix-spec-proposals/pull/2414). diff --git a/changelogs/client_server/newsfragments/1938.new b/changelogs/client_server/newsfragments/1938.new deleted file mode 100644 index 62c23cd4..00000000 --- a/changelogs/client_server/newsfragments/1938.new +++ /dev/null @@ -1 +0,0 @@ -Add `POST /_matrix/client/v3/rooms/{roomId}/report`, as per [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151). diff --git a/changelogs/client_server/newsfragments/1944.feature b/changelogs/client_server/newsfragments/1944.feature deleted file mode 100644 index 916ab978..00000000 --- a/changelogs/client_server/newsfragments/1944.feature +++ /dev/null @@ -1 +0,0 @@ -Add error codes to requestToken endpoints, as per [MSC4178](https://github.com/matrix-org/matrix-spec-proposals/pull/4178). diff --git a/changelogs/client_server/newsfragments/1947.clarification b/changelogs/client_server/newsfragments/1947.clarification deleted file mode 100644 index 3764243a..00000000 --- a/changelogs/client_server/newsfragments/1947.clarification +++ /dev/null @@ -1 +0,0 @@ -Correct OpenAPI specification for query parameters to `GET /_matrix/client/v3/thirdparty/location/{protocol}` endpoint. diff --git a/changelogs/client_server/newsfragments/1967.clarification b/changelogs/client_server/newsfragments/1967.clarification deleted file mode 100644 index 1b47b068..00000000 --- a/changelogs/client_server/newsfragments/1967.clarification +++ /dev/null @@ -1 +0,0 @@ -Sort VoIP events semantically. diff --git a/changelogs/client_server/newsfragments/1973.clarification b/changelogs/client_server/newsfragments/1973.clarification deleted file mode 100644 index 27fc5863..00000000 --- a/changelogs/client_server/newsfragments/1973.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify that servers must forward custom keys in `PusherData` when sending notifications to the push gateway. diff --git a/changelogs/client_server/newsfragments/1978.clarification b/changelogs/client_server/newsfragments/1978.clarification deleted file mode 100644 index bdcce777..00000000 --- a/changelogs/client_server/newsfragments/1978.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify formats of string types. diff --git a/changelogs/client_server/newsfragments/1979.clarification b/changelogs/client_server/newsfragments/1979.clarification deleted file mode 100644 index bdcce777..00000000 --- a/changelogs/client_server/newsfragments/1979.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify formats of string types. diff --git a/changelogs/client_server/newsfragments/1980.clarification b/changelogs/client_server/newsfragments/1980.clarification deleted file mode 100644 index bdcce777..00000000 --- a/changelogs/client_server/newsfragments/1980.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify formats of string types. diff --git a/changelogs/client_server/newsfragments/1983.clarification b/changelogs/client_server/newsfragments/1983.clarification deleted file mode 100644 index 764372f8..00000000 --- a/changelogs/client_server/newsfragments/1983.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify that the async upload endpoint will return 404 in some cases. diff --git a/changelogs/client_server/newsfragments/1994.feature b/changelogs/client_server/newsfragments/1994.feature deleted file mode 100644 index 67c00f22..00000000 --- a/changelogs/client_server/newsfragments/1994.feature +++ /dev/null @@ -1 +0,0 @@ -Remove reply fallbacks, as per [MSC2781](https://github.com/matrix-org/matrix-spec-proposals/issues/2781). \ No newline at end of file diff --git a/changelogs/client_server/newsfragments/1995.feature b/changelogs/client_server/newsfragments/1995.feature deleted file mode 100644 index 5dd1a126..00000000 --- a/changelogs/client_server/newsfragments/1995.feature +++ /dev/null @@ -1 +0,0 @@ -Clarify the allowed HTTP methods in CORS responses, as per [MSC4138](https://github.com/matrix-org/matrix-spec-proposals/pull/4138). diff --git a/changelogs/client_server/newsfragments/2011.feature b/changelogs/client_server/newsfragments/2011.feature deleted file mode 100644 index 5dd1a126..00000000 --- a/changelogs/client_server/newsfragments/2011.feature +++ /dev/null @@ -1 +0,0 @@ -Clarify the allowed HTTP methods in CORS responses, as per [MSC4138](https://github.com/matrix-org/matrix-spec-proposals/pull/4138). diff --git a/changelogs/client_server/newsfragments/2014.feature b/changelogs/client_server/newsfragments/2014.feature deleted file mode 100644 index 0671f14d..00000000 --- a/changelogs/client_server/newsfragments/2014.feature +++ /dev/null @@ -1 +0,0 @@ -Add new `M_USER_SUSPENDED` error code behaviour, as per [MSC3823](https://github.com/matrix-org/matrix-spec-proposals/pull/3823). \ No newline at end of file diff --git a/changelogs/client_server/newsfragments/2015.clarification b/changelogs/client_server/newsfragments/2015.clarification deleted file mode 100644 index 1952e036..00000000 --- a/changelogs/client_server/newsfragments/2015.clarification +++ /dev/null @@ -1 +0,0 @@ -Remove distinction between `StateFilter` and `RoomEventFilter`. diff --git a/changelogs/client_server/newsfragments/2016.clarification b/changelogs/client_server/newsfragments/2016.clarification deleted file mode 100644 index 34aa3b22..00000000 --- a/changelogs/client_server/newsfragments/2016.clarification +++ /dev/null @@ -1 +0,0 @@ -Add hyperlinks throughout the specification. diff --git a/changelogs/client_server/newsfragments/2017.clarification b/changelogs/client_server/newsfragments/2017.clarification deleted file mode 100644 index a202eec3..00000000 --- a/changelogs/client_server/newsfragments/2017.clarification +++ /dev/null @@ -1 +0,0 @@ -Use `json` instead of `json5` for syntax highlighting. diff --git a/changelogs/client_server/newsfragments/2028.new b/changelogs/client_server/newsfragments/2028.new deleted file mode 100644 index 62c23cd4..00000000 --- a/changelogs/client_server/newsfragments/2028.new +++ /dev/null @@ -1 +0,0 @@ -Add `POST /_matrix/client/v3/rooms/{roomId}/report`, as per [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151). diff --git a/changelogs/client_server/newsfragments/2029.clarification b/changelogs/client_server/newsfragments/2029.clarification deleted file mode 100644 index 74050082..00000000 --- a/changelogs/client_server/newsfragments/2029.clarification +++ /dev/null @@ -1 +0,0 @@ -Specify order that one-time keys are issued by `/keys/claim`, as per [MSC4225](https://github.com/matrix-org/matrix-spec-proposals/pull/4225). diff --git a/changelogs/internal/newsfragments/1967.clarification b/changelogs/internal/newsfragments/1967.clarification deleted file mode 100644 index 9b86faca..00000000 --- a/changelogs/internal/newsfragments/1967.clarification +++ /dev/null @@ -1 +0,0 @@ -Add `x-weight` property for sorting events rendered with the `event-group` shortcode. diff --git a/changelogs/internal/newsfragments/1969.clarification b/changelogs/internal/newsfragments/1969.clarification deleted file mode 100644 index db9e1a1a..00000000 --- a/changelogs/internal/newsfragments/1969.clarification +++ /dev/null @@ -1 +0,0 @@ -Enforce consistent vertical spacing between paragraphs in endpoint definitions. \ No newline at end of file diff --git a/changelogs/internal/newsfragments/1970.clarification b/changelogs/internal/newsfragments/1970.clarification deleted file mode 100644 index 5d20fcf9..00000000 --- a/changelogs/internal/newsfragments/1970.clarification +++ /dev/null @@ -1 +0,0 @@ -Remove `boxes/added-in-paragraph` shortcode. diff --git a/changelogs/internal/newsfragments/1971.clarification b/changelogs/internal/newsfragments/1971.clarification deleted file mode 100644 index 6c61b653..00000000 --- a/changelogs/internal/newsfragments/1971.clarification +++ /dev/null @@ -1 +0,0 @@ -Remove `withVersioning` parameter of `rver-fragment` shortcode. diff --git a/changelogs/internal/newsfragments/1972.clarification b/changelogs/internal/newsfragments/1972.clarification deleted file mode 100644 index dc4a85f4..00000000 --- a/changelogs/internal/newsfragments/1972.clarification +++ /dev/null @@ -1 +0,0 @@ -Remove `span` element from `added-in` and `changed-in` shortcodes. diff --git a/changelogs/internal/newsfragments/1975.clarification b/changelogs/internal/newsfragments/1975.clarification deleted file mode 100644 index 4edcc477..00000000 --- a/changelogs/internal/newsfragments/1975.clarification +++ /dev/null @@ -1 +0,0 @@ -Fix formatting of `added-in` and `changed-in` shortcodes by using `%` delimiter. diff --git a/changelogs/internal/newsfragments/1976.clarification b/changelogs/internal/newsfragments/1976.clarification deleted file mode 100644 index 259cbffe..00000000 --- a/changelogs/internal/newsfragments/1976.clarification +++ /dev/null @@ -1 +0,0 @@ -Remove CSS workaround for scroll-anchoring. diff --git a/changelogs/internal/newsfragments/1977.clarification b/changelogs/internal/newsfragments/1977.clarification deleted file mode 100644 index 3a5e1099..00000000 --- a/changelogs/internal/newsfragments/1977.clarification +++ /dev/null @@ -1 +0,0 @@ -Rename `custom-formats.yaml` to `string-formats.yaml` and update its docs. diff --git a/changelogs/internal/newsfragments/1984.clarification b/changelogs/internal/newsfragments/1984.clarification deleted file mode 100644 index cb11abe6..00000000 --- a/changelogs/internal/newsfragments/1984.clarification +++ /dev/null @@ -1 +0,0 @@ -Fix relative URLs when serving the specification with a custom `baseURL`. diff --git a/changelogs/internal/newsfragments/1985.clarification b/changelogs/internal/newsfragments/1985.clarification deleted file mode 100644 index 9f01fb6f..00000000 --- a/changelogs/internal/newsfragments/1985.clarification +++ /dev/null @@ -1 +0,0 @@ -Rename `.htmltest.yaml` to `.htmltest.yml`. diff --git a/changelogs/internal/newsfragments/1991.clarification b/changelogs/internal/newsfragments/1991.clarification deleted file mode 100644 index 5f641bff..00000000 --- a/changelogs/internal/newsfragments/1991.clarification +++ /dev/null @@ -1 +0,0 @@ -Improve the JS script to highlight the current ToC entry. diff --git a/changelogs/internal/newsfragments/1996.clarification b/changelogs/internal/newsfragments/1996.clarification deleted file mode 100644 index fbfe46cc..00000000 --- a/changelogs/internal/newsfragments/1996.clarification +++ /dev/null @@ -1 +0,0 @@ -Upgrade docsy to 0.11.0 and hugo to 0.139.0. diff --git a/changelogs/internal/newsfragments/1997.clarification b/changelogs/internal/newsfragments/1997.clarification deleted file mode 100644 index cb11abe6..00000000 --- a/changelogs/internal/newsfragments/1997.clarification +++ /dev/null @@ -1 +0,0 @@ -Fix relative URLs when serving the specification with a custom `baseURL`. diff --git a/changelogs/internal/newsfragments/1999.clarification b/changelogs/internal/newsfragments/1999.clarification deleted file mode 100644 index 94017535..00000000 --- a/changelogs/internal/newsfragments/1999.clarification +++ /dev/null @@ -1 +0,0 @@ -Improve the quality of the rendered diagrams diff --git a/changelogs/internal/newsfragments/2000.clarification b/changelogs/internal/newsfragments/2000.clarification deleted file mode 100644 index 24cf7b81..00000000 --- a/changelogs/internal/newsfragments/2000.clarification +++ /dev/null @@ -1 +0,0 @@ -Update the Inter font and allow the browser to render the page before it is loaded \ No newline at end of file diff --git a/changelogs/internal/newsfragments/2001.clarification b/changelogs/internal/newsfragments/2001.clarification deleted file mode 100644 index 7e262d4b..00000000 --- a/changelogs/internal/newsfragments/2001.clarification +++ /dev/null @@ -1 +0,0 @@ -Use a proper Matrix favicon diff --git a/changelogs/internal/newsfragments/2002.clarification b/changelogs/internal/newsfragments/2002.clarification deleted file mode 100644 index 5f641bff..00000000 --- a/changelogs/internal/newsfragments/2002.clarification +++ /dev/null @@ -1 +0,0 @@ -Improve the JS script to highlight the current ToC entry. diff --git a/changelogs/internal/newsfragments/2003.clarification b/changelogs/internal/newsfragments/2003.clarification deleted file mode 100644 index 79541db2..00000000 --- a/changelogs/internal/newsfragments/2003.clarification +++ /dev/null @@ -1 +0,0 @@ -Clean up unused CSS classes in `openapi/render-operation` partial. diff --git a/changelogs/internal/newsfragments/2005.clarification b/changelogs/internal/newsfragments/2005.clarification deleted file mode 100644 index db9e1a1a..00000000 --- a/changelogs/internal/newsfragments/2005.clarification +++ /dev/null @@ -1 +0,0 @@ -Enforce consistent vertical spacing between paragraphs in endpoint definitions. \ No newline at end of file diff --git a/changelogs/internal/newsfragments/2006.clarification b/changelogs/internal/newsfragments/2006.clarification deleted file mode 100644 index d535a8fb..00000000 --- a/changelogs/internal/newsfragments/2006.clarification +++ /dev/null @@ -1 +0,0 @@ -Fix `changed-in` partial when used with multiple paragraphs. diff --git a/changelogs/internal/newsfragments/2007.clarification b/changelogs/internal/newsfragments/2007.clarification deleted file mode 100644 index fbfe46cc..00000000 --- a/changelogs/internal/newsfragments/2007.clarification +++ /dev/null @@ -1 +0,0 @@ -Upgrade docsy to 0.11.0 and hugo to 0.139.0. diff --git a/changelogs/internal/newsfragments/2008.clarification b/changelogs/internal/newsfragments/2008.clarification deleted file mode 100644 index d9f7818b..00000000 --- a/changelogs/internal/newsfragments/2008.clarification +++ /dev/null @@ -1 +0,0 @@ -Optimize generated CSS by removing unused selectors. diff --git a/changelogs/internal/newsfragments/2009.clarification b/changelogs/internal/newsfragments/2009.clarification deleted file mode 100644 index eed0f477..00000000 --- a/changelogs/internal/newsfragments/2009.clarification +++ /dev/null @@ -1 +0,0 @@ -Remove trailing slash on void HTML elements. diff --git a/changelogs/internal/newsfragments/2021.clarification b/changelogs/internal/newsfragments/2021.clarification deleted file mode 100644 index af282431..00000000 --- a/changelogs/internal/newsfragments/2021.clarification +++ /dev/null @@ -1 +0,0 @@ -Remove `type` and `language` attributes of `script` element. diff --git a/changelogs/internal/newsfragments/2022.clarification b/changelogs/internal/newsfragments/2022.clarification deleted file mode 100644 index c9395967..00000000 --- a/changelogs/internal/newsfragments/2022.clarification +++ /dev/null @@ -1 +0,0 @@ -Change the accessible role of info boxes to `note`. diff --git a/changelogs/push_gateway/newsfragments/1968.clarification b/changelogs/push_gateway/newsfragments/1968.clarification deleted file mode 100644 index 5bf945b6..00000000 --- a/changelogs/push_gateway/newsfragments/1968.clarification +++ /dev/null @@ -1 +0,0 @@ -Document the schema of `PusherData`. diff --git a/changelogs/push_gateway/newsfragments/1974.clarification b/changelogs/push_gateway/newsfragments/1974.clarification deleted file mode 100644 index 46c086a9..00000000 --- a/changelogs/push_gateway/newsfragments/1974.clarification +++ /dev/null @@ -1 +0,0 @@ -The path of HTTP pusher URLs is fixed to `/_matrix/push/v1/notify`. diff --git a/changelogs/room_versions/newsfragments/2024.clarification b/changelogs/room_versions/newsfragments/2024.clarification deleted file mode 100644 index d346cc20..00000000 --- a/changelogs/room_versions/newsfragments/2024.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify rule 4.3.1 of the auth rules in room version 11 to state which event's `sender` the `state_key` needs to match. diff --git a/changelogs/server_server/newsfragments/1926.clarification b/changelogs/server_server/newsfragments/1926.clarification deleted file mode 100644 index 172bea67..00000000 --- a/changelogs/server_server/newsfragments/1926.clarification +++ /dev/null @@ -1 +0,0 @@ -Add 403 error response to `/_matrix/federation/v1/state_ids/{roomId}`. diff --git a/changelogs/server_server/newsfragments/2004.feature b/changelogs/server_server/newsfragments/2004.feature deleted file mode 100644 index 73478c40..00000000 --- a/changelogs/server_server/newsfragments/2004.feature +++ /dev/null @@ -1 +0,0 @@ -Make ACLs apply to EDUs, as per [MSC4163](https://github.com/matrix-org/matrix-spec-proposals/pull/4163). diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index fad71273..cde52c16 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -61,14 +61,14 @@ copyright = "The Matrix.org Foundation CIC" [params.version] # must be one of "unstable", "current", "historical" # this is used to decide whether to show a banner pointing to the current release -status = "unstable" +status = "stable" # A URL pointing to the latest, stable release of the spec. To be shown in the unstable version warning banner. current_version_url = "https://spec.matrix.org/latest" # The following is used when status = "stable", and is displayed in various UI elements on a released version # of the spec. CI will set these values here automatically when a release git tag (i.e `v1.5`) is created. -# major = "1" -# minor = "12" -# release_date = "October 07, 2024" +major = "1" +minor = "13" +release_date = "December 19, 2024" # User interface configuration [params.ui] diff --git a/content/changelog/v1.13.md b/content/changelog/v1.13.md new file mode 100644 index 00000000..ead58ee9 --- /dev/null +++ b/content/changelog/v1.13.md @@ -0,0 +1,122 @@ +--- +title: v1.13 Changelog +linkTitle: v1.13 +type: docs +outputs: + - html + - checklist +date: 2024-12-19T09:22:47-07:00 +--- + + + + + + +
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.13
Release dateDecember 19, 2024
Checklist}}">checklist.md
+ + + +## Client-Server API + +**New Endpoints** + +- Add `POST /_matrix/client/v3/rooms/{roomId}/report`, as per [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151). ([#1938](https://github.com/matrix-org/matrix-spec/issues/1938), [#2028](https://github.com/matrix-org/matrix-spec/issues/2028)) + +**Backwards Compatible Changes** + +- Add error codes to requestToken endpoints, as per [MSC4178](https://github.com/matrix-org/matrix-spec-proposals/pull/4178). ([#1944](https://github.com/matrix-org/matrix-spec/issues/1944)) +- Remove reply fallbacks, as per [MSC2781](https://github.com/matrix-org/matrix-spec-proposals/issues/2781). ([#1994](https://github.com/matrix-org/matrix-spec/issues/1994)) +- Clarify the allowed HTTP methods in CORS responses, as per [MSC4138](https://github.com/matrix-org/matrix-spec-proposals/pull/4138). ([#1995](https://github.com/matrix-org/matrix-spec/issues/1995), [#2011](https://github.com/matrix-org/matrix-spec/issues/2011)) +- Add new `M_USER_SUSPENDED` error code behaviour, as per [MSC3823](https://github.com/matrix-org/matrix-spec-proposals/pull/3823). ([#2014](https://github.com/matrix-org/matrix-spec/issues/2014)) + +**Spec Clarifications** + +- The `reason` parameter in `POST /_matrix/client/v3/rooms/{roomId}/report/{eventId}` can be omitted instead of left blank, as per [MSC2414](https://github.com/matrix-org/matrix-spec-proposals/pull/2414). ([#1938](https://github.com/matrix-org/matrix-spec/issues/1938)) +- Correct OpenAPI specification for query parameters to `GET /_matrix/client/v3/thirdparty/location/{protocol}` endpoint. ([#1947](https://github.com/matrix-org/matrix-spec/issues/1947)) +- Sort VoIP events semantically. ([#1967](https://github.com/matrix-org/matrix-spec/issues/1967)) +- Clarify that servers must forward custom keys in `PusherData` when sending notifications to the push gateway. ([#1973](https://github.com/matrix-org/matrix-spec/issues/1973)) +- Clarify formats of string types. ([#1978](https://github.com/matrix-org/matrix-spec/issues/1978), [#1979](https://github.com/matrix-org/matrix-spec/issues/1979), [#1980](https://github.com/matrix-org/matrix-spec/issues/1980)) +- Clarify that the async upload endpoint will return 404 in some cases. ([#1983](https://github.com/matrix-org/matrix-spec/issues/1983)) +- Remove distinction between `StateFilter` and `RoomEventFilter`. ([#2015](https://github.com/matrix-org/matrix-spec/issues/2015)) +- Add hyperlinks throughout the specification. ([#2016](https://github.com/matrix-org/matrix-spec/issues/2016)) +- Use `json` instead of `json5` for syntax highlighting. ([#2017](https://github.com/matrix-org/matrix-spec/issues/2017)) +- Specify order that one-time keys are issued by `/keys/claim`, as per [MSC4225](https://github.com/matrix-org/matrix-spec-proposals/pull/4225). ([#2029](https://github.com/matrix-org/matrix-spec/issues/2029)) + + +## Server-Server API + +**Backwards Compatible Changes** + +- Make ACLs apply to EDUs, as per [MSC4163](https://github.com/matrix-org/matrix-spec-proposals/pull/4163). ([#2004](https://github.com/matrix-org/matrix-spec/issues/2004)) + +**Spec Clarifications** + +- Add 403 error response to `/_matrix/federation/v1/state_ids/{roomId}`. ([#1926](https://github.com/matrix-org/matrix-spec/issues/1926)) + + +## Application Service API + +**Backwards Compatible Changes** + +- Allow sending ephemeral data to application services, as per [MSC2409](https://github.com/matrix-org/matrix-spec-proposals/pull/2409). ([#2018](https://github.com/matrix-org/matrix-spec/issues/2018)) + + +## Identity Service API + +No significant changes. + + +## Push Gateway API + +**Spec Clarifications** + +- Document the schema of `PusherData`. ([#1968](https://github.com/matrix-org/matrix-spec/issues/1968)) +- The path of HTTP pusher URLs is fixed to `/_matrix/push/v1/notify`. ([#1974](https://github.com/matrix-org/matrix-spec/issues/1974)) + + +## Room Versions + +**Spec Clarifications** + +- Clarify rule 4.3.1 of the auth rules in room version 11 to state which event's `sender` the `state_key` needs to match. ([#2024](https://github.com/matrix-org/matrix-spec/issues/2024)) + + +## Appendices + +**Spec Clarifications** + +- Remove note about reference implementations. ([#1966](https://github.com/matrix-org/matrix-spec/issues/1966)) + + +## Internal Changes/Tooling + +**Spec Clarifications** + +- Add `x-weight` property for sorting events rendered with the `event-group` shortcode. ([#1967](https://github.com/matrix-org/matrix-spec/issues/1967)) +- Enforce consistent vertical spacing between paragraphs in endpoint definitions. ([#1969](https://github.com/matrix-org/matrix-spec/issues/1969), [#2005](https://github.com/matrix-org/matrix-spec/issues/2005)) +- Remove `boxes/added-in-paragraph` shortcode. ([#1970](https://github.com/matrix-org/matrix-spec/issues/1970)) +- Remove `withVersioning` parameter of `rver-fragment` shortcode. ([#1971](https://github.com/matrix-org/matrix-spec/issues/1971)) +- Remove `span` element from `added-in` and `changed-in` shortcodes. ([#1972](https://github.com/matrix-org/matrix-spec/issues/1972)) +- Fix formatting of `added-in` and `changed-in` shortcodes by using `%` delimiter. ([#1975](https://github.com/matrix-org/matrix-spec/issues/1975)) +- Remove CSS workaround for scroll-anchoring. ([#1976](https://github.com/matrix-org/matrix-spec/issues/1976)) +- Rename `custom-formats.yaml` to `string-formats.yaml` and update its docs. ([#1977](https://github.com/matrix-org/matrix-spec/issues/1977)) +- Fix relative URLs when serving the specification with a custom `baseURL`. ([#1984](https://github.com/matrix-org/matrix-spec/issues/1984), [#1997](https://github.com/matrix-org/matrix-spec/issues/1997)) +- Rename `.htmltest.yaml` to `.htmltest.yml`. ([#1985](https://github.com/matrix-org/matrix-spec/issues/1985)) +- Improve the JS script to highlight the current ToC entry. ([#1991](https://github.com/matrix-org/matrix-spec/issues/1991), [#2002](https://github.com/matrix-org/matrix-spec/issues/2002)) +- Upgrade docsy to 0.11.0 and hugo to 0.139.0. ([#1996](https://github.com/matrix-org/matrix-spec/issues/1996), [#2007](https://github.com/matrix-org/matrix-spec/issues/2007)) +- Improve the quality of the rendered diagrams ([#1999](https://github.com/matrix-org/matrix-spec/issues/1999)) +- Update the Inter font and allow the browser to render the page before it is loaded ([#2000](https://github.com/matrix-org/matrix-spec/issues/2000)) +- Use a proper Matrix favicon ([#2001](https://github.com/matrix-org/matrix-spec/issues/2001)) +- Clean up unused CSS classes in `openapi/render-operation` partial. ([#2003](https://github.com/matrix-org/matrix-spec/issues/2003)) +- Fix `changed-in` partial when used with multiple paragraphs. ([#2006](https://github.com/matrix-org/matrix-spec/issues/2006)) +- Optimize generated CSS by removing unused selectors. ([#2008](https://github.com/matrix-org/matrix-spec/issues/2008)) +- Remove trailing slash on void HTML elements. ([#2009](https://github.com/matrix-org/matrix-spec/issues/2009)) +- Remove `type` and `language` attributes of `script` element. ([#2021](https://github.com/matrix-org/matrix-spec/issues/2021)) +- Change the accessible role of info boxes to `note`. ([#2022](https://github.com/matrix-org/matrix-spec/issues/2022)) From 1d98e96300e69fde2ddba28064506ad7d3c877b9 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Thu, 19 Dec 2024 09:25:15 -0700 Subject: [PATCH 3/6] -> unstable --- config/_default/hugo.toml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index cde52c16..6a95c9bb 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -61,14 +61,14 @@ copyright = "The Matrix.org Foundation CIC" [params.version] # must be one of "unstable", "current", "historical" # this is used to decide whether to show a banner pointing to the current release -status = "stable" +status = "unstable" # A URL pointing to the latest, stable release of the spec. To be shown in the unstable version warning banner. current_version_url = "https://spec.matrix.org/latest" # The following is used when status = "stable", and is displayed in various UI elements on a released version # of the spec. CI will set these values here automatically when a release git tag (i.e `v1.5`) is created. -major = "1" -minor = "13" -release_date = "December 19, 2024" +# major = "1" +# minor = "13" +# release_date = "December 19, 2024" # User interface configuration [params.ui] From 2df3f7a7bfc53be62b8e8ac67b07239739174b9e Mon Sep 17 00:00:00 2001 From: Kim Brose <2803622+HarHarLinks@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:59:42 +0000 Subject: [PATCH 4/6] Clarify wording in the /join endpoints summaries and descriptions (#2038) --- changelogs/client_server/newsfragments/2038.clarification | 1 + data/api/client-server/joining.yaml | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) create mode 100644 changelogs/client_server/newsfragments/2038.clarification diff --git a/changelogs/client_server/newsfragments/2038.clarification b/changelogs/client_server/newsfragments/2038.clarification new file mode 100644 index 00000000..169ca65c --- /dev/null +++ b/changelogs/client_server/newsfragments/2038.clarification @@ -0,0 +1 @@ +Clarify wording in the `/join` endpoints' summaries and descriptions. Contributed by @HarHarLinks. diff --git a/data/api/client-server/joining.yaml b/data/api/client-server/joining.yaml index dda0d867..1019abbd 100644 --- a/data/api/client-server/joining.yaml +++ b/data/api/client-server/joining.yaml @@ -18,12 +18,12 @@ info: paths: "/rooms/{roomId}/join": post: - summary: Start the requesting user participating in a particular room. + summary: Join the requesting user to a particular room. description: |- *Note that this API requires a room ID, not alias.* `/join/{roomIdOrAlias}` *exists if you have a room alias.* - This API starts a user participating in a particular room, if that user + This API starts a user's participation in a particular room, if that user is allowed to participate in that room. After this call, the client is allowed to see all current state events in the room, and all subsequent events associated with the room until the user leaves the room. @@ -113,11 +113,11 @@ paths: - Room membership "/join/{roomIdOrAlias}": post: - summary: Start the requesting user participating in a particular room. + summary: Join the requesting user to a particular room. description: |- *Note that this API takes either a room ID or alias, unlike* `/rooms/{roomId}/join`. - This API starts a user participating in a particular room, if that user + This API starts a user's participation in a particular room, if that user is allowed to participate in that room. After this call, the client is allowed to see all current state events in the room, and all subsequent events associated with the room until the user leaves the room. From baa60bf728621973e6a3c71e080a88d6296e306b Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 23 Dec 2024 08:50:52 -0700 Subject: [PATCH 5/6] Update path to config in release steps (#2041) * Update path to config in release steps * changelog --- changelogs/internal/newsfragments/2041.clarification | 1 + meta/releasing.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 changelogs/internal/newsfragments/2041.clarification diff --git a/changelogs/internal/newsfragments/2041.clarification b/changelogs/internal/newsfragments/2041.clarification new file mode 100644 index 00000000..fd9a66f7 --- /dev/null +++ b/changelogs/internal/newsfragments/2041.clarification @@ -0,0 +1 @@ +Update release steps documentation. \ No newline at end of file diff --git a/meta/releasing.md b/meta/releasing.md index eb2c16b7..29de7d8f 100644 --- a/meta/releasing.md +++ b/meta/releasing.md @@ -62,7 +62,7 @@ Assuming the preparation work is complete, all that remains is the actual specif release. 1. Create a `release/v1.2` branch where `v1.2` is the version you're about to release. -2. Update the `params.version` section of `config.toml` to use the following template: +2. Update the `params.version` section of `./config/_default/hugo.toml` to use the following template: ```toml [params.version] status = "stable" @@ -95,7 +95,7 @@ release. * Upload the artifacts of the GitHub Actions build for the release to the GitHub release as artifacts themselves. This should be the tarball that will be deployed to spec.matrix.org. -10. Commit a reversion to `params.version` of `config.toml` on `main`: +10. Commit a reversion to `params.version` of `./config/_default/hugo.toml` on `main`: ```toml [params.version] status = "unstable" From 6f1e64cb1271189cfa6bc310564f35d895326671 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= <76261501+zecakeh@users.noreply.github.com> Date: Mon, 23 Dec 2024 18:46:52 +0100 Subject: [PATCH 6/6] Generate changelog release info with Hugo rather than when generating changelog (#2033) --- changelogs/header.md | 15 ------ .../internal/newsfragments/2033.clarification | 1 + content/changelog/_index.md | 2 +- content/changelog/v1.1.md | 17 +------ content/changelog/v1.10.md | 18 +------- content/changelog/v1.11.md | 18 +------- content/changelog/v1.12.md | 18 +------- content/changelog/v1.13.md | 18 +------- content/changelog/v1.2.md | 17 +------ content/changelog/v1.3.md | 17 +------ content/changelog/v1.4.md | 17 +------ content/changelog/v1.5.md | 17 +------ content/changelog/v1.6.md | 17 +------ content/changelog/v1.7.md | 17 +------ content/changelog/v1.8.md | 18 +------- content/changelog/v1.9.md | 18 +------- layouts/_default/single.checklist.md | 4 -- layouts/docs/changelog.checklist.md | 34 ++++++++++++++ layouts/docs/changelog.html | 46 +++++++++++++++++++ layouts/shortcodes/changelog/changelogs.html | 8 ---- meta/releasing.md | 5 +- scripts/generate-changelog.sh | 31 +++++++------ 22 files changed, 127 insertions(+), 246 deletions(-) delete mode 100644 changelogs/header.md create mode 100644 changelogs/internal/newsfragments/2033.clarification delete mode 100644 layouts/_default/single.checklist.md create mode 100644 layouts/docs/changelog.checklist.md create mode 100644 layouts/docs/changelog.html delete mode 100644 layouts/shortcodes/changelog/changelogs.html diff --git a/changelogs/header.md b/changelogs/header.md deleted file mode 100644 index 21f3b4d2..00000000 --- a/changelogs/header.md +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/VERSION
Release dateDATE
Checklist}}">checklist.md
- - diff --git a/changelogs/internal/newsfragments/2033.clarification b/changelogs/internal/newsfragments/2033.clarification new file mode 100644 index 00000000..9d3e7596 --- /dev/null +++ b/changelogs/internal/newsfragments/2033.clarification @@ -0,0 +1 @@ +Generate the changelog release info with Hugo, rather than the changelog generation script. diff --git a/content/changelog/_index.md b/content/changelog/_index.md index ccb55f6f..c1c55f6c 100644 --- a/content/changelog/_index.md +++ b/content/changelog/_index.md @@ -4,4 +4,4 @@ type: docs weight: 1000 --- -{{% changelog/changelogs %}} + diff --git a/content/changelog/v1.1.md b/content/changelog/v1.1.md index 7e31122d..acfc1b21 100644 --- a/content/changelog/v1.1.md +++ b/content/changelog/v1.1.md @@ -2,26 +2,13 @@ title: v1.1 Changelog linkTitle: v1.1 type: docs +layout: changelog outputs: - html - checklist -date: 2021-11-09T00:00:00+0000 +date: 2021-11-09 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-doc/tree/v1.1
Release dateNovember 09, 2021
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.10.md b/content/changelog/v1.10.md index 8a0e496d..a3115a1f 100644 --- a/content/changelog/v1.10.md +++ b/content/changelog/v1.10.md @@ -2,26 +2,12 @@ title: v1.10 Changelog linkTitle: v1.10 type: docs +layout: changelog outputs: - html - checklist -date: 2024-03-22T09:59:45-06:00 +date: 2024-03-22 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.10
Release dateMarch 22, 2024
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.11.md b/content/changelog/v1.11.md index d38d874b..7f12c1e3 100644 --- a/content/changelog/v1.11.md +++ b/content/changelog/v1.11.md @@ -2,26 +2,12 @@ title: v1.11 Changelog linkTitle: v1.11 type: docs +layout: changelog outputs: - html - checklist -date: 2024-06-20T10:20:43-06:00 +date: 2024-06-20 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.11
Release dateJune 20, 2024
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.12.md b/content/changelog/v1.12.md index 8124ca28..4f4f65dd 100644 --- a/content/changelog/v1.12.md +++ b/content/changelog/v1.12.md @@ -2,26 +2,12 @@ title: v1.12 Changelog linkTitle: v1.12 type: docs +layout: changelog outputs: - html - checklist -date: 2024-10-07T13:32:03-06:00 +date: 2024-10-07 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.12
Release dateOctober 07, 2024
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.13.md b/content/changelog/v1.13.md index ead58ee9..df91175b 100644 --- a/content/changelog/v1.13.md +++ b/content/changelog/v1.13.md @@ -2,26 +2,12 @@ title: v1.13 Changelog linkTitle: v1.13 type: docs +layout: changelog outputs: - html - checklist -date: 2024-12-19T09:22:47-07:00 +date: 2024-12-19 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.13
Release dateDecember 19, 2024
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.2.md b/content/changelog/v1.2.md index 224da53f..9fd35eb5 100644 --- a/content/changelog/v1.2.md +++ b/content/changelog/v1.2.md @@ -2,26 +2,13 @@ title: v1.2 Changelog linkTitle: v1.2 type: docs +layout: changelog outputs: - html - checklist -date: 2022-02-02T00:00:00+0000 +date: 2022-02-02 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-doc/tree/v1.2
Release dateFebruary 02, 2022
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.3.md b/content/changelog/v1.3.md index b8c99a7c..270783e7 100644 --- a/content/changelog/v1.3.md +++ b/content/changelog/v1.3.md @@ -2,26 +2,13 @@ title: v1.3 Changelog linkTitle: v1.3 type: docs +layout: changelog outputs: - html - checklist -date: 2022-06-15T00:00:00+0100 +date: 2022-06-15 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.3
Release dateJune 15, 2022
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.4.md b/content/changelog/v1.4.md index 10510d80..febb3874 100644 --- a/content/changelog/v1.4.md +++ b/content/changelog/v1.4.md @@ -2,26 +2,13 @@ title: v1.4 Changelog linkTitle: v1.4 type: docs +layout: changelog outputs: - html - checklist -date: 2022-09-29T00:00:00+0100 +date: 2022-09-29 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.4
Release dateSeptember 29, 2022
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.5.md b/content/changelog/v1.5.md index 9f23a019..71931cc7 100644 --- a/content/changelog/v1.5.md +++ b/content/changelog/v1.5.md @@ -2,26 +2,13 @@ title: v1.5 Changelog linkTitle: v1.5 type: docs +layout: changelog outputs: - html - checklist -date: 2022-11-17T08:22:11-07:00 +date: 2022-11-17 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.5
Release dateNovember 17, 2022
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.6.md b/content/changelog/v1.6.md index d47c36b5..f2a129c6 100644 --- a/content/changelog/v1.6.md +++ b/content/changelog/v1.6.md @@ -2,26 +2,13 @@ title: v1.6 Changelog linkTitle: v1.6 type: docs +layout: changelog outputs: - html - checklist -date: 2023-02-14T08:25:40-07:00 +date: 2023-02-14 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.6
Release dateFebruary 14, 2023
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.7.md b/content/changelog/v1.7.md index f4b2b63e..86f0b4ad 100644 --- a/content/changelog/v1.7.md +++ b/content/changelog/v1.7.md @@ -2,26 +2,13 @@ title: v1.7 Changelog linkTitle: v1.7 type: docs +layout: changelog outputs: - html - checklist -date: 2023-05-25T09:47:21-06:00 +date: 2023-05-25 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.7
Release dateMay 25, 2023
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.8.md b/content/changelog/v1.8.md index 1883d10a..6e5cf995 100644 --- a/content/changelog/v1.8.md +++ b/content/changelog/v1.8.md @@ -2,26 +2,12 @@ title: v1.8 Changelog linkTitle: v1.8 type: docs +layout: changelog outputs: - html - checklist -date: 2023-08-23T09:23:53-06:00 +date: 2023-08-23 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.8
Release dateAugust 23, 2023
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/content/changelog/v1.9.md b/content/changelog/v1.9.md index a3971bd2..9c38785d 100644 --- a/content/changelog/v1.9.md +++ b/content/changelog/v1.9.md @@ -2,26 +2,12 @@ title: v1.9 Changelog linkTitle: v1.9 type: docs +layout: changelog outputs: - html - checklist -date: 2023-11-29T10:04:26-07:00 +date: 2023-11-29 --- - - - - - - -
Git commithttps://github.com/matrix-org/matrix-spec/tree/v1.9
Release dateNovember 29, 2023
Checklist}}">checklist.md
- - ## Client-Server API diff --git a/layouts/_default/single.checklist.md b/layouts/_default/single.checklist.md deleted file mode 100644 index f885a316..00000000 --- a/layouts/_default/single.checklist.md +++ /dev/null @@ -1,4 +0,0 @@ -{{ .RawContent - | replaceRE "\n- " "\n- [ ] " - | replaceRE "\n?" "" - | replaceRE "Checklist.*\n" "" }} diff --git a/layouts/docs/changelog.checklist.md b/layouts/docs/changelog.checklist.md new file mode 100644 index 00000000..17051c71 --- /dev/null +++ b/layouts/docs/changelog.checklist.md @@ -0,0 +1,34 @@ +{{- /* + + Template to render a page with a `changelog` layout as a markdown checklist. + + This transforms the markdown source of the changelog to change list items, + which in turn are them transformed into a rendered checklist. + + Stable releases will additionally have a table at the top of the page with + information about the release, including: + + * A link to the matrix-spec repository at the time of the release, with the + version taken from the `linkTitle` in the frontmatter of the page. + * The date of the release, taken from the `date` in the frontmatter of the + page. + +*/ -}} + +{{ $version := lower .LinkTitle -}} +# Matrix Specification {{ .Title }} + +{{ if ne $version "unstable" -}} +{{- /* + + Most markdown parsers require the header to recognize a markdown table, + so add an empty header. + +*/ -}} +| | | +|---|---| +| Git commit | {{ printf "https://github.com/matrix-org/matrix-spec/tree/%s" $version }} | +| Release date | {{ .Date | time.Format ":date_long" }} | +{{ end -}} + +{{ .RawContent | replaceRE "\n- " "\n- [ ] " }} diff --git a/layouts/docs/changelog.html b/layouts/docs/changelog.html new file mode 100644 index 00000000..b23c8074 --- /dev/null +++ b/layouts/docs/changelog.html @@ -0,0 +1,46 @@ +{{- /* + + Template to render a page with a `changelog` layout or the `changelog` + section page. This conflation seems to be a limitation of Hugo currently, it + uses this template for both cases. + + For the `changelog` section page, this redirects the page to the latest + version's changelog page. + + For a page with a `changelog` layout, this adds a table at the top of the + page with information about the release: + + * A link to the matrix-spec repository at the time of the release, with the + version taken from the `linkTitle` in the frontmatter of the page, unless + it is the unstable changelog. + * The date of the release, taken from the `date` in the frontmatter of the + page, unless it is the unstable changelog. + * A link to the markdown checklist format of the changelog. The `outputs` in + the frontmatter of the page must include `checklist`. + +*/ -}} + +{{ define "main" }} +{{ if .IsSection -}} + {{ with index .RegularPages.ByDate.Reverse 0 -}} + + {{ end -}} +{{ else -}} + {{ $version := lower .LinkTitle -}} +
+

{{ .Title }}

+ + + {{ if ne $version "unstable" -}} + {{ $commitLink := printf "https://github.com/matrix-org/matrix-spec/tree/%s" $version -}} + + + {{ end -}} + {{ $checklist := .OutputFormats.Get "checklist" -}} + +
Git commit{{ $commitLink }}
Release date{{ .Date | time.Format ":date_long" }}
Checklistchecklist.md
+ + {{ .Content }} +
+{{ end -}} +{{ end }} diff --git a/layouts/shortcodes/changelog/changelogs.html b/layouts/shortcodes/changelog/changelogs.html deleted file mode 100644 index d6c0add8..00000000 --- a/layouts/shortcodes/changelog/changelogs.html +++ /dev/null @@ -1,8 +0,0 @@ -{{/* - This template is used to redirect the changelog section under - "content/changelogs" to the latest version's changelog page. -*/}} - -{{ with index .Page.RegularPages.ByDate.Reverse 0 }} - -{{ end }} diff --git a/meta/releasing.md b/meta/releasing.md index 29de7d8f..273e4eaa 100644 --- a/meta/releasing.md +++ b/meta/releasing.md @@ -79,8 +79,9 @@ release. 3. Commit the changes. 4. Generate the changelog. 1. Activate your python virtual environment. - 2. Run `./scripts/generate-changelog.sh v1.2 "October 01, 2021"` (using the correct - version number and same `release_date` format from the hugo config). + 2. Run `./scripts/generate-changelog.sh v1.2` (using the correct version number). + The script will use the current date. If that date is wrong, correct the document + by using the same `YYYY-MM-DD` date format. 3. Commit the result. 5. Tag the branch with the spec release with a format of `v1.2` (if releasing Matrix 1.2). 6. Push the release branch and the tag. diff --git a/scripts/generate-changelog.sh b/scripts/generate-changelog.sh index 9447dac5..678af60f 100755 --- a/scripts/generate-changelog.sh +++ b/scripts/generate-changelog.sh @@ -1,20 +1,16 @@ # /bin/bash -# Usage: ./scripts/generate-changelog.sh v1.2 "April 01, 2021" -# or: ./scripts/generate-changelog.sh vUNSTABLE +# Usage: ./scripts/generate-changelog.sh v1.2 for changelogs of stable releases +# or: ./scripts/generate-changelog.sh vUNSTABLE for the unstable changelog. set -e VERSION="$1" -DATE="$2" -cd `dirname $0`/../changelogs - -# Pre-cleanup just in case it wasn't done on the last run -rm -f rendered.md - -# Generate changelog -towncrier --yes +if [ -z "$VERSION" ]; then + echo "ERROR: The version of the changelog must be provided" + exit 1 +fi if [ "$VERSION" = "vUNSTABLE" ]; then TITLE="Changes since last release" @@ -26,6 +22,14 @@ else FILENAME="$VERSION.md" fi +cd `dirname $0`/../changelogs + +# Pre-cleanup just in case it wasn't done on the last run +rm -f rendered.md + +# Generate changelog +towncrier --yes + { # Prepare the header # We include the generation date in the front matter so that we can use it @@ -35,16 +39,13 @@ fi title: $TITLE linkTitle: $LINKTITLE type: docs +layout: changelog outputs: - html - checklist -date: $(date -Iseconds) +date: $(date -Idate) --- EOF - if [ "$VERSION" != "vUNSTABLE" ]; then - sed -e "s/VERSION/$1/g" -e "s/DATE/$2/g" header.md - fi - # Remove trailing whitespace (such as our intentionally blank RST headings) sed -e "s/[ ]*$//" rendered.md } > ../content/changelog/$FILENAME