mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-13 06:54:10 +01:00
Merge branch 'main' into shared-errors
This commit is contained in:
Richard van der Hoff
GitHub
commit
fc4662370a
|
|
@ -1 +0,0 @@
|
|||
Remove note about reference implementations.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Allow sending ephemeral data to application services, as per [MSC2409](https://github.com/matrix-org/matrix-spec-proposals/pull/2409).
|
||||
|
|
@ -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).
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add `POST /_matrix/client/v3/rooms/{roomId}/report` as per [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151).
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add error codes to requestToken endpoints (MSC4178).
|
||||
|
|
@ -1 +0,0 @@
|
|||
Correct OpenAPI specification for query parameters to `GET /_matrix/client/v3/thirdparty/location/{protocol}` endpoint.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Sort VoIP events semantically.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Clarify that servers must forward custom keys in `PusherData` when sending notifications to the push gateway.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Clarify formats of string types.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Clarify formats of string types.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Clarify formats of string types.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Clarify that the async upload endpoint will return 404 in some cases.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Remove reply fallbacks, as per [MSC2781](https://github.com/matrix-org/matrix-spec-proposals/issues/2781).
|
||||
|
|
@ -1 +0,0 @@
|
|||
Clarify the allowed HTTP methods in CORS responses, as per [MSC4138](https://github.com/matrix-org/matrix-spec-proposals/pull/4138).
|
||||
|
|
@ -1 +0,0 @@
|
|||
Clarify the allowed HTTP methods in CORS responses, as per [MSC4138](https://github.com/matrix-org/matrix-spec-proposals/pull/4138).
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add new `M_USER_SUSPENDED` error code behaviour, as per [MSC3823](https://github.com/matrix-org/matrix-spec-proposals/pull/3823).
|
||||
|
|
@ -1 +0,0 @@
|
|||
Remove distinction between `StateFilter` and `RoomEventFilter`.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add hyperlinks throughout the specification.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Use `json` instead of `json5` for syntax highlighting.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add `POST /_matrix/client/v3/rooms/{roomId}/report` as per [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151).
|
||||
|
|
@ -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).
|
||||
|
|
@ -0,0 +1 @@
|
|||
Clarify wording in the `/join` endpoints' summaries and descriptions. Contributed by @HarHarLinks.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
VERSION = Replaced by the version number (eg: v1.2)
|
||||
DATE = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/VERSION">https://github.com/matrix-org/matrix-spec/tree/VERSION</a></td>
|
||||
<tr><th>Release date</th><td>DATE</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/VERSION" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add `x-weight` property for sorting events rendered with the `event-group` shortcode.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Enforce consistent vertical spacing between paragraphs in endpoint definitions.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Remove `boxes/added-in-paragraph` shortcode.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Remove `withVersioning` parameter of `rver-fragment` shortcode.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Remove `span` element from `added-in` and `changed-in` shortcodes.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Fix formatting of `added-in` and `changed-in` shortcodes by using `%` delimiter.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Remove CSS workaround for scroll-anchoring.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Rename `custom-formats.yaml` to `string-formats.yaml` and update its docs.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Fix relative URLs when serving the specification with a custom `baseURL`.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Rename `.htmltest.yaml` to `.htmltest.yml`.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Improve the JS script to highlight the current ToC entry.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Upgrade docsy to 0.11.0 and hugo to 0.139.0.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Fix relative URLs when serving the specification with a custom `baseURL`.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Improve the quality of the rendered diagrams
|
||||
|
|
@ -1 +0,0 @@
|
|||
Update the Inter font and allow the browser to render the page before it is loaded
|
||||
|
|
@ -1 +0,0 @@
|
|||
Use a proper Matrix favicon
|
||||
|
|
@ -1 +0,0 @@
|
|||
Improve the JS script to highlight the current ToC entry.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Clean up unused CSS classes in `openapi/render-operation` partial.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Enforce consistent vertical spacing between paragraphs in endpoint definitions.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Fix `changed-in` partial when used with multiple paragraphs.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Upgrade docsy to 0.11.0 and hugo to 0.139.0.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Optimize generated CSS by removing unused selectors.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Remove trailing slash on void HTML elements.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Remove `type` and `language` attributes of `script` element.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Change the accessible role of info boxes to `note`.
|
||||
1
changelogs/internal/newsfragments/2033.clarification
Normal file
1
changelogs/internal/newsfragments/2033.clarification
Normal file
|
|
@ -0,0 +1 @@
|
|||
Generate the changelog release info with Hugo, rather than the changelog generation script.
|
||||
1
changelogs/internal/newsfragments/2041.clarification
Normal file
1
changelogs/internal/newsfragments/2041.clarification
Normal file
|
|
@ -0,0 +1 @@
|
|||
Update release steps documentation.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Document the schema of `PusherData`.
|
||||
|
|
@ -1 +0,0 @@
|
|||
The path of HTTP pusher URLs is fixed to `/_matrix/push/v1/notify`.
|
||||
|
|
@ -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.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add 403 error response to `/_matrix/federation/v1/state_ids/{roomId}`.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Make ACLs apply to EDUs as per [MSC4163](https://github.com/matrix-org/matrix-spec-proposals/pull/4163).
|
||||
|
|
@ -67,8 +67,8 @@ 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"
|
||||
# minor = "13"
|
||||
# release_date = "December 19, 2024"
|
||||
|
||||
# User interface configuration
|
||||
[params.ui]
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ type: docs
|
|||
weight: 1000
|
||||
---
|
||||
|
||||
{{% changelog/changelogs %}}
|
||||
<!-- This page will be redirected to the latest version's changelog -->
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.1 = Replaced by the version number (eg: v1.2)
|
||||
November 09, 2021 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-doc/tree/v1.1">https://github.com/matrix-org/matrix-doc/tree/v1.1</a></td>
|
||||
<tr><th>Release date</th><td>November 09, 2021</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.1" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
## Client-Server API
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.10 = Replaced by the version number (eg: v1.2)
|
||||
March 22, 2024 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.10">https://github.com/matrix-org/matrix-spec/tree/v1.10</a></td>
|
||||
<tr><th>Release date</th><td>March 22, 2024</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.10" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
|
||||
## Client-Server API
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.11 = Replaced by the version number (eg: v1.2)
|
||||
June 20, 2024 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.11">https://github.com/matrix-org/matrix-spec/tree/v1.11</a></td>
|
||||
<tr><th>Release date</th><td>June 20, 2024</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.11" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
|
||||
## Client-Server API
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.12 = Replaced by the version number (eg: v1.2)
|
||||
October 07, 2024 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.12">https://github.com/matrix-org/matrix-spec/tree/v1.12</a></td>
|
||||
<tr><th>Release date</th><td>October 07, 2024</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.12" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
|
||||
## Client-Server API
|
||||
|
||||
|
|
|
|||
108
content/changelog/v1.13.md
Normal file
108
content/changelog/v1.13.md
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
---
|
||||
title: v1.13 Changelog
|
||||
linkTitle: v1.13
|
||||
type: docs
|
||||
layout: changelog
|
||||
outputs:
|
||||
- html
|
||||
- checklist
|
||||
date: 2024-12-19
|
||||
---
|
||||
|
||||
## 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))
|
||||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.2 = Replaced by the version number (eg: v1.2)
|
||||
February 02, 2022 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-doc/tree/v1.2">https://github.com/matrix-org/matrix-doc/tree/v1.2</a></td>
|
||||
<tr><th>Release date</th><td>February 02, 2022</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.2" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
## Client-Server API
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.3 = Replaced by the version number (eg: v1.2)
|
||||
June 15, 2022 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.3">https://github.com/matrix-org/matrix-spec/tree/v1.3</a></td>
|
||||
<tr><th>Release date</th><td>June 15, 2022</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.3" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
## Client-Server API
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.4 = Replaced by the version number (eg: v1.2)
|
||||
September 29, 2022 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.4">https://github.com/matrix-org/matrix-spec/tree/v1.4</a></td>
|
||||
<tr><th>Release date</th><td>September 29, 2022</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.4" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
## Client-Server API
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.5 = Replaced by the version number (eg: v1.2)
|
||||
November 17, 2022 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.5">https://github.com/matrix-org/matrix-spec/tree/v1.5</a></td>
|
||||
<tr><th>Release date</th><td>November 17, 2022</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.5" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
## Client-Server API
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.6 = Replaced by the version number (eg: v1.2)
|
||||
February 14, 2023 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.6">https://github.com/matrix-org/matrix-spec/tree/v1.6</a></td>
|
||||
<tr><th>Release date</th><td>February 14, 2023</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.6" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
## Client-Server API
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.7 = Replaced by the version number (eg: v1.2)
|
||||
May 25, 2023 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.7">https://github.com/matrix-org/matrix-spec/tree/v1.7</a></td>
|
||||
<tr><th>Release date</th><td>May 25, 2023</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.7" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
## Client-Server API
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.8 = Replaced by the version number (eg: v1.2)
|
||||
August 23, 2023 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.8">https://github.com/matrix-org/matrix-spec/tree/v1.8</a></td>
|
||||
<tr><th>Release date</th><td>August 23, 2023</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.8" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
|
||||
## Client-Server API
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<!--
|
||||
This is a header file for the generated changelog.
|
||||
|
||||
Variables:
|
||||
v1.9 = Replaced by the version number (eg: v1.2)
|
||||
November 29, 2023 = Replaced by the date (eg: April 01, 2021)
|
||||
-->
|
||||
|
||||
<table class="release-info">
|
||||
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.9">https://github.com/matrix-org/matrix-spec/tree/v1.9</a></td>
|
||||
<tr><th>Release date</th><td>November 29, 2023</td>
|
||||
<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.9" outputFormat="Checklist" >}}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
|
||||
|
||||
## Client-Server API
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
{{ .RawContent
|
||||
| replaceRE "\n- " "\n- [ ] "
|
||||
| replaceRE "<!--(.|\\s)*?-->\n?" ""
|
||||
| replaceRE "<tr><th>Checklist.*\n" "" }}
|
||||
34
layouts/docs/changelog.checklist.md
Normal file
34
layouts/docs/changelog.checklist.md
Normal file
|
|
@ -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- [ ] " }}
|
||||
46
layouts/docs/changelog.html
Normal file
46
layouts/docs/changelog.html
Normal file
|
|
@ -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 -}}
|
||||
<meta http-equiv="refresh" content="0; url={{ .RelPermalink }}">
|
||||
{{ end -}}
|
||||
{{ else -}}
|
||||
{{ $version := lower .LinkTitle -}}
|
||||
<div class="td-content">
|
||||
<h1>{{ .Title }}</h1>
|
||||
|
||||
<table class="release-info">
|
||||
{{ if ne $version "unstable" -}}
|
||||
{{ $commitLink := printf "https://github.com/matrix-org/matrix-spec/tree/%s" $version -}}
|
||||
<tr><th>Git commit</th><td><a href="{{ $commitLink }}">{{ $commitLink }}</a></td>
|
||||
<tr><th>Release date</th><td>{{ .Date | time.Format ":date_long" }}</td>
|
||||
{{ end -}}
|
||||
{{ $checklist := .OutputFormats.Get "checklist" -}}
|
||||
<tr><th>Checklist</th><td><a href="{{ $checklist.RelPermalink }}">checklist.md</a></td>
|
||||
</table>
|
||||
|
||||
{{ .Content }}
|
||||
</div>
|
||||
{{ end -}}
|
||||
{{ end }}
|
||||
|
|
@ -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 }}
|
||||
<meta http-equiv="refresh" content="0; url={{ .RelPermalink }}">
|
||||
{{ end }}
|
||||
|
|
@ -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"
|
||||
|
|
@ -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.
|
||||
|
|
@ -95,7 +96,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"
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in a new issue