Merge branch 'main' into johannes/profile-403

.github/ISSUE_TEMPLATE/release.md

@@ -16,20 +16,22 @@ Previous release: <!-- LINK TO LAST RELEASE'S CHECKLIST -->
 
 Preflight checklist ([release steps](https://github.com/matrix-org/matrix-spec/blob/main/meta/releasing.md)):
 
+* [ ] Pin this issue to the repo.
 * [ ] Ensure the social media account holders are available for the release day.
-* [ ] Blog post written
+* [ ] Blog post written.
-* [ ] Check for release blockers that may have been missed
+* [ ] Check for release blockers that may have been missed.
-* [ ] Review/fix the changelog
+* [ ] Review/fix the changelog.
 
 Release checklist ([release steps](https://github.com/matrix-org/matrix-spec/blob/main/meta/releasing.md)):
-* [ ] Branch stuffs
+* [ ] Branch stuffs.
-* [ ] Github release artifact
+* [ ] Github release artifact.
-* [ ] Published to spec.matrix.org
+* [ ] Published to spec.matrix.org.
-* [ ] All links work
+* [ ] All links work.
-* [ ] Publish blog post
+* [ ] Publish blog post.
-* [ ] Announce in #matrix-spec, client developers, HS developers, SCT office, and other rooms as warranted
+* [ ] Announce in #matrix-spec, client developers, HS developers, SCT office, and other rooms as warranted.
-* [ ] Post to Twitter/Mastodon
+* [ ] Post to Twitter/Mastodon.
-* [ ] Close this issue
+* [ ] Close this issue.
+* [ ] Unpin this issue from the repo.
 
 Known release blockers:
 * [ ] <!-- Issue/PR link -->

.github/workflows/main.yml

@@ -177,7 +177,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: changelog-artifact
-          path: content/changelog/vUNSTABLE.md
+          path: content/changelog/unstable.md
 
   build-spec:
     name: "📖 Build the spec"
@@ -193,7 +193,7 @@ jobs:
       - name: "➕ Setup Hugo"
         uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0
         with:
-          hugo-version: '0.113.0'
+          hugo-version: '0.117.0'
           extended: true
       - name: "📥 Source checkout"
         uses: actions/checkout@v4

.github/workflows/netlify.yaml

@@ -25,8 +25,11 @@ jobs:
         id: readctx
         # we need to find the PR number that corresponds to the branch, which we do by
         # searching the GH API
+        env:
+          OWNER_LOGIN: ${{ github.event.workflow_run.head_repository.owner.login }}
+          HEAD_BRANCH: ${{ github.event.workflow_run.head_branch }}
         run: |
-          head_branch='${{github.event.workflow_run.head_repository.owner.login}}:${{github.event.workflow_run.head_branch}}'
+          head_branch="${OWNER_LOGIN}:${HEAD_BRANCH}"
           echo "head branch: $head_branch"
           pulls_uri="https://api.github.com/repos/${{ github.repository }}/pulls?head=$(jq -Rr '@uri' <<<$head_branch)"
           pr_number=$(curl -H 'Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' "$pulls_uri" |

.htmltest.yaml

@@ -4,3 +4,4 @@
 IgnoreDirectoryMissingTrailingSlash: true
 DirectoryPath: spec
 CheckExternal: false
+IgnoreInternalEmptyHash: true

CONTRIBUTING.rst

@@ -99,6 +99,8 @@ the ``newsfragments`` directory. The ``type`` can be one of the following:
 
 * ``deprecation`` - Used when deprecating something.
 
+* ``removal`` - Used when removing something that was unused or previously deprecated.
+
 All news fragments must have a brief summary explaining the change in the
 contents of the file. The summary must end in a full stop to be in line with
 the style guide and formatting must be done using Markdown.
@@ -163,19 +165,6 @@ include the line in your commit or pull request comment::
 
     Signed-off-by: Your Name <your@email.example.org>
 
-...using your real name; unfortunately pseudonyms and anonymous contributions
+Git allows you to add this signoff automatically when using the ``-s``
-can't be accepted. Git makes this trivial - just use the -s flag when you do
+flag to ``git commit``, which uses the name and email set in your
-``git commit``, having first set ``user.name`` and ``user.email`` git configs
+``user.name`` and ``user.email`` git configs.
-(which you should have done anyway :)
-
-Private sign off
-~~~~~~~~~~~~~~~~
-
-If you would like to provide your legal name privately to the Matrix.org
-Foundation (instead of in a public commit or comment), you can do so by emailing
-your legal name and a link to the pull request to dco@matrix.org. It helps to
-include "sign off" or similar in the subject line. You will then be instructed
-further.
-
-Once private sign off is complete, doing so for future contributions will not
-be required.

README.md

@@ -61,7 +61,7 @@ place after an MSC has been accepted, not as part of a proposal itself.
 
 1. Install the extended version (often the OS default) of Hugo:
    <https://gohugo.io/getting-started/installing>. Note that at least Hugo
-   v0.113.0 is required.
+   v0.117.0 is required.
 
    Alternatively, use the Docker image at
    https://hub.docker.com/r/klakegg/hugo/. (The "extended edition" is required

assets/scss/_variables_project.scss

@@ -40,15 +40,17 @@ $table-bg: $secondary-lightest-background;
 $td-enable-google-fonts: false;
 
 /*
- * Replace the default font with Inter.
+ * The $font-family-sans-serif definition here overrides the default value set by docsy
- *
+ * (https://github.com/matrix-org/docsy/blob/66a4e61d2d34edc7196b9df83a7d09cd4af14b47/assets/scss/_variables.scss#L68)
- * The $font-family-sans-serif definition here overrides the default value set by docsy:
- * https://github.com/matrix-org/docsy/blob/66a4e61d2d34edc7196b9df83a7d09cd4af14b47/assets/scss/_variables.scss#L68
- * and adds "Inter" to the front.
- *
- * The font itself is loaded via stylesheet link layouts/partials/hooks/head-end.html.
  */
-$font-family-sans-serif: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
+$font-family-sans-serif:
+  // Add "Inter" to the front, making it the default. The font itself is loaded via stylesheet
+  // links in layouts/partials/hooks/head-end.html.
+  "Inter",
+  -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue",
+  // Insert fonts suited for mathematical symbols on different platforms before "Arial"
+  "STIX Two Math", "Cambria Math", "Noto Sans Math", "Dejavu Sans",
+  Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
 
 // Disable smooth scrolling as it makes TOC highlighting jump during the transition.
 $enable-smooth-scroll: false;

changelogs/appendices/newsfragments/1791.clarification

@@ -1 +0,0 @@
-Define 'Opaque Identifier Grammar'.

changelogs/appendices/newsfragments/1819.clarification

@@ -1 +0,0 @@
-Define common cryptographic key representation.

changelogs/appendices/newsfragments/1823.deprecation

@@ -1 +0,0 @@
-Deprecate linking to events in rooms identified by alias, as per [MSC4132](https://github.com/matrix-org/matrix-spec-proposals/pull/4132).

changelogs/appendices/newsfragments/1928.clarification

@@ -0,0 +1 @@
+Document that the spec uses RFC 2119. Contributed by @HarHarLinks.

changelogs/application_service/newsfragments/1772.clarification

@@ -1 +0,0 @@
-Fix the OpenAPI definition of the security schemes.

changelogs/application_service/newsfragments/1810.clarification

@@ -1 +0,0 @@
-Clarify that appservices should be notified of events relating to the sender_localpart user.

changelogs/application_service/newsfragments/1928.clarification

@@ -0,0 +1 @@
+Document that the spec uses RFC 2119. Contributed by @HarHarLinks.

changelogs/client_server/newsfragments/1755.clarification

@@ -1 +0,0 @@
-Add support for muting in VoIP calls, as per [MSC3291](https://github.com/matrix-org/matrix-spec-proposals/pull/3291).

changelogs/client_server/newsfragments/1757.feature

@@ -1 +0,0 @@
-Add optional `animated` query string option to `GET /_matrix/media/v3/thumbnail`, as per [MSC2705](https://github.com/matrix-org/matrix-spec-proposals/pull/2705).

changelogs/client_server/newsfragments/1772.clarification

@@ -1 +0,0 @@
-Fix the OpenAPI definition of the security schemes.

changelogs/client_server/newsfragments/1776.clarification

@@ -1 +0,0 @@
-Clarify that the `type` of the `POST /login` request must be one of the types returned by the `GET /login` response.

changelogs/client_server/newsfragments/1808.clarification

@@ -1 +0,0 @@
-Deprecate authentication via a query string, as per [MSC4126](https://github.com/matrix-org/matrix-spec-proposals/issues/4126).

changelogs/client_server/newsfragments/1812.feature

@@ -1 +0,0 @@
-Specify terms of services at registration, as per [MSC1692](https://github.com/matrix-org/matrix-spec-proposals/pull/1692).

changelogs/client_server/newsfragments/1813.clarification

@@ -1 +0,0 @@
-Use `patternProperties` in more places with supported formats.

changelogs/client_server/newsfragments/1816.clarification

@@ -1 +0,0 @@
-Add support for mathematical messages, as per [MSC2191](https://github.com/matrix-org/matrix-spec-proposals/pull/2191).

changelogs/client_server/newsfragments/1819.clarification

@@ -1 +0,0 @@
-Rename "recovery key" to "backup decryption key".

changelogs/client_server/newsfragments/1822.clarification

@@ -1 +0,0 @@
-Refactor the OpenAPI definitions of the content repository endpoints.

changelogs/client_server/newsfragments/1828.feature

@@ -1 +0,0 @@
-Do not require UIA when first uploading cross-signing keys, as per [MSC3967](https://github.com/matrix-org/matrix-spec-proposals/pull/3967).

changelogs/client_server/newsfragments/1829.clarification

@@ -1 +0,0 @@
-Clarify that the device's Ed25519 signing key should be used in QR code verification (as opposed to the device's Curve25519 identity key).

changelogs/client_server/newsfragments/1842.removal

@@ -0,0 +1 @@
+Remove references to device-specific push rules.

changelogs/client_server/newsfragments/1846.clarification

@@ -1 +0,0 @@
-Clarify that per-request UIA for /login/get_token is an RFC 2119 MUST requirement.

changelogs/client_server/newsfragments/1847.feature

@@ -1 +0,0 @@
-Add the new `unsigned.membership` property to events served over the client-server API, as per [MSC4115](https://github.com/matrix-org/matrix-spec-proposals/pull/4115).

changelogs/client_server/newsfragments/1853.clarification

@@ -1 +0,0 @@
-Fix various typos throughout the specification.

changelogs/client_server/newsfragments/1855.clarification

@@ -0,0 +1 @@
+Rename and sort the modules in the feature profiles table for easier skimming.

changelogs/client_server/newsfragments/1870.removal

@@ -0,0 +1 @@
+Remove the deprecated name attribute on HTML anchor elements as per [MSC4159](https://github.com/matrix-org/matrix-spec-proposals/pull/4159).

changelogs/client_server/newsfragments/1871.clarification

@@ -0,0 +1 @@
+Clarify that room avatars cannot be encrypted.

changelogs/client_server/newsfragments/1875.clarification

@@ -0,0 +1 @@
+Document the acronyms and alternate names for the "Secrets" section.

changelogs/client_server/newsfragments/1888.clarification

@@ -0,0 +1 @@
+Improve recommendation for how to form transaction IDs.

changelogs/client_server/newsfragments/1890.clarification

@@ -0,0 +1 @@
+Clarify that the deprecated `dont_notify` and `coalesce` push rule actions MUST be ignored, not rejected.

changelogs/client_server/newsfragments/1895.feature

@@ -0,0 +1 @@
+Add support for marking rooms as unread as per [MSC2867](https://github.com/matrix-org/matrix-spec-proposals/pull/2867).

changelogs/client_server/newsfragments/1897.clarification

@@ -0,0 +1 @@
+Add missing references to `m.set_displayname`, `m.set_avatar_url` and `m.3pid_changes` in capabilities table.

changelogs/client_server/newsfragments/1899.clarification

@@ -0,0 +1 @@
+Clarify that the fallback login page calls `window.matrixLogin.onLogin` instead of `window.onLogin`.

changelogs/client_server/newsfragments/1903.clarification

@@ -0,0 +1 @@
+Remove confusing description of restricted rooms with no valid conditions.

changelogs/client_server/newsfragments/1905.clarification

@@ -0,0 +1 @@
+Clarify that `window.matrixLogin.onLogin` is called with the response body of `POST /_matrix/client/v3/login`.

changelogs/client_server/newsfragments/1908.clarification

@@ -0,0 +1 @@
+Document the `m.get_login_token` capability as per [MSC3882](https://github.com/matrix-org/matrix-spec-proposals/pull/3882).

changelogs/client_server/newsfragments/1909.clarification

@@ -0,0 +1 @@
+The `User identifier` object in `POST /_matrix/client/v3/login` contains additional properties that depend on the identification type.

changelogs/client_server/newsfragments/1910.clarification

@@ -0,0 +1 @@
+Don't mention that `GET /_matrix/client/v3/profile/{userId}` can return additional properties because this is true for almost every endpoint.

changelogs/client_server/newsfragments/1916.clarification

@@ -0,0 +1 @@
+Improve wording of the unauthenticated media deprecation box. Contributed by @HarHarLinks.

changelogs/client_server/newsfragments/1920.clarification

@@ -0,0 +1 @@
+Additional properties in `.well-known/matrix/client` don't have to be objects.

changelogs/client_server/newsfragments/1928.clarification

@@ -0,0 +1 @@
+Document that the spec uses RFC 2119. Contributed by @HarHarLinks.

changelogs/client_server/newsfragments/1933.deprecation

@@ -0,0 +1 @@
+Deprecate the `server_name` query parameter on `/_matrix/client/v3/join/{roomIdOrAlias}` and `/_matrix/client/v3/knock/{roomIdOrAlias}` as per [MSC4156](https://github.com/matrix-org/matrix-spec-proposals/pull/4156).

changelogs/client_server/newsfragments/1933.feature

@@ -0,0 +1 @@
+Add `via` query parameter on `/_matrix/client/v3/join/{roomIdOrAlias}` and `/_matrix/client/v3/knock/{roomIdOrAlias}` as per [MSC4156](https://github.com/matrix-org/matrix-spec-proposals/pull/4156).

changelogs/client_server/newsfragments/1934.feature

@@ -0,0 +1 @@
+Add account locking as per [MSC3939](https://github.com/matrix-org/matrix-spec-proposals/pull/3939).

changelogs/client_server/newsfragments/1935.clarification

@@ -0,0 +1 @@
+Specify `Content-Type` and `Content-Disposition` usage in the media repo, as per [MSC2701](https://github.com/matrix-org/matrix-spec-proposals/pull/2701) and [MSC2702](https://github.com/matrix-org/matrix-spec-proposals/pull/2702).

changelogs/client_server/newsfragments/1941.feature

@@ -0,0 +1 @@
+Add support for marking rooms as unread as per [MSC2867](https://github.com/matrix-org/matrix-spec-proposals/pull/2867).

changelogs/client_server/newsfragments/1945.clarification

@@ -0,0 +1 @@
+Additional keys in `GET /capabilities` don't have to be objects.

changelogs/client_server/newsfragments/1959.feature

@@ -0,0 +1 @@
+Guest accounts can now download/thumbnail media from the new authenticated endpoints, as per [MSC4189](https://github.com/matrix-org/matrix-spec-proposals/pull/4189).

changelogs/header.md

@@ -6,11 +6,10 @@ Variables:
     DATE     = Replaced by the date (eg: April 01, 2021)
 -->
 
-## VERSION
-
 <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="/changelog/VERSION/checklist.md">checklist.md</a></td>
 </table>
 
 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->

changelogs/identity_service/newsfragments/1772.clarification

@@ -1 +0,0 @@
-Fix the OpenAPI definition of the security schemes.

changelogs/identity_service/newsfragments/1808.clarification

@@ -1 +0,0 @@
-Deprecate authentication via a query string, as per [MSC4126](https://github.com/matrix-org/matrix-spec-proposals/issues/4126).

changelogs/identity_service/newsfragments/1928.clarification

@@ -0,0 +1 @@
+Document that the spec uses RFC 2119. Contributed by @HarHarLinks.

changelogs/internal/newsfragments/1765.clarification

@@ -1 +0,0 @@
-Fix npm release script for `@matrix-org/spec`.

changelogs/internal/newsfragments/1769.clarification

@@ -1 +0,0 @@
-Formatting fixes in CONTRIBUTING.rst.

changelogs/internal/newsfragments/1770.clarification

@@ -1 +0,0 @@
-Reduce whitespace on mobile viewports

changelogs/internal/newsfragments/1771.clarification

@@ -1 +0,0 @@
-Arrange rows in `.basic-info` tables vertically when horizontal space is constrained.

changelogs/internal/newsfragments/1773.clarification

@@ -1 +0,0 @@
-Simplify uses of `resolve-refs` partial.

changelogs/internal/newsfragments/1775.clarification

@@ -1 +0,0 @@
-Fix Hugo warnings.

changelogs/internal/newsfragments/1781.clarification

@@ -1 +0,0 @@
-Fix `github-labels.rst`

changelogs/internal/newsfragments/1786.clarification

@@ -1 +0,0 @@
-Upgrade jsonschema and python-jsonpath CI scripts dependencies.

changelogs/internal/newsfragments/1787.clarification

@@ -1 +0,0 @@
-Solve `allOf` recursively in OpenAPI and JSON Schemas.

changelogs/internal/newsfragments/1788.clarification

@@ -1 +0,0 @@
-Fix Hugo warnings.

changelogs/internal/newsfragments/1789.clarification

@@ -1 +0,0 @@
-Fix property type resolution in `render-object-table` partial.

changelogs/internal/newsfragments/1793.misc

@@ -1 +0,0 @@
-Factor out common definition of `Tag` type.

changelogs/internal/newsfragments/1794.clarification

@@ -1 +0,0 @@
-Update the version of Hugo used to render the spec to v0.124.1.

changelogs/internal/newsfragments/1796.clarification

@@ -1 +0,0 @@
-Add support for pattern formats for `patternProperties`.

changelogs/internal/newsfragments/1797.clarification

@@ -1 +0,0 @@
-Clean up unnecessary `allOf`s in OpenAPI definitions.

changelogs/internal/newsfragments/1798.clarification

@@ -1 +0,0 @@
-Show information about "Additional Properties" in object tables.

changelogs/internal/newsfragments/1799.clarification

@@ -1 +0,0 @@
-Fix anchors for schemas under `oneOf`.

changelogs/internal/newsfragments/1800.clarification

@@ -1 +0,0 @@
-Use reference to `OneTimeKeys` schema in OpenAPI definitions.

changelogs/internal/newsfragments/1801.clarification

@@ -1 +0,0 @@
-Do not use the `title` of objects containing only `additionalProperties` or `patternProperties`.

changelogs/internal/newsfragments/1802.clarification

@@ -1 +0,0 @@
-Add anchors in `definition` shortcode.

changelogs/internal/newsfragments/1803.clarification

@@ -1 +0,0 @@
-Update most CI actions.

changelogs/internal/newsfragments/1804.clarification

@@ -1 +0,0 @@
-Update typos CI action.

changelogs/internal/newsfragments/1805.clarification

@@ -1 +0,0 @@
-Set python version for the Towncrier CI job.

changelogs/internal/newsfragments/1806.clarification

@@ -1 +0,0 @@
-Replace `set-output` with environment files in CI.

changelogs/internal/newsfragments/1809.clarification

@@ -1 +0,0 @@
-Render response headers.

changelogs/internal/newsfragments/1814.clarification

@@ -1 +0,0 @@
-Add support for rendering string formats.

changelogs/internal/newsfragments/1831.clarification

@@ -1 +0,0 @@
-Clean up pull request template.

changelogs/internal/newsfragments/1856.clarification

@@ -1 +0,0 @@
-Fix syntax errors in the spec release issue template.

changelogs/internal/newsfragments/1886.clarification

@@ -0,0 +1 @@
+Clarified "real name" in contributor requirements to match other matrix-org projects.

changelogs/internal/newsfragments/1907.clarification

@@ -0,0 +1 @@
+Document the `removal` changelog category.

changelogs/internal/newsfragments/1914.clarification

@@ -0,0 +1 @@
+The Matrix.org Foundation no longer requires "real" or "legally identifiable" names in order to contribute to projects.

changelogs/internal/newsfragments/1919.clarification

@@ -0,0 +1 @@
+Use dedicated fonts for better support of mathematical symbols.

changelogs/internal/newsfragments/1928.clarification

@@ -0,0 +1 @@
+Document that the spec uses RFC 2119. Contributed by @HarHarLinks.

changelogs/internal/newsfragments/1937.clarification

@@ -0,0 +1 @@
+Provide markdown checklists for changelogs under `/changelog/$VERSION/checklist.md`.

changelogs/internal/newsfragments/1940.clarification

@@ -0,0 +1 @@
+Add the `deprecated` field to properties of OpenAPI definitions and JSON Schemas.

changelogs/internal/newsfragments/1954.clarification

@@ -0,0 +1 @@
+Exclude markdown checklists from alternate output formats.

changelogs/internal/newsfragments/1956.clarification

@@ -0,0 +1 @@
+Use relative permalink to redirect to latest changelog.

changelogs/push_gateway/newsfragments/1928.clarification

@@ -0,0 +1 @@
+Document that the spec uses RFC 2119. Contributed by @HarHarLinks.

changelogs/room_versions/newsfragments/1824.clarification

@@ -1 +0,0 @@
-Clarify that redaction events are still subject to all applicable auth rules.

changelogs/room_versions/newsfragments/1827.clarification

@@ -1 +0,0 @@
-Fix minor spelling mistake of object being spelt "obiect".

changelogs/room_versions/newsfragments/1848.clarification

@@ -1 +0,0 @@
-Fix various typos throughout the specification.