Merge ae4e2f9291 into 5a9f3c3bca

.github/workflows/main.yml

@@ -196,8 +196,6 @@ jobs:
     needs: [calculate-baseurl, build-openapi, generate-changelog]
     # run even if generate-changelog was skipped
     if: ${{ always() }}
-    env:
-      baseURL: "${{ needs.calculate-baseurl.outputs.baseURL }}"
     steps:
       - name: "➕ Setup Node"
         uses: actions/setup-node@v4
@@ -220,10 +218,8 @@ jobs:
         with:
           name: changelog-artifact
           path: content/changelog
-
       - name: "⚙️ hugo"
-        run: hugo --baseURL "${baseURL}" -d "spec${baseURL}"
-
+        run: hugo --baseURL "${{ needs.calculate-baseurl.outputs.baseURL }}" -d "spec"
       # We manually unpack the spec OpenAPI definition JSON to the website tree
       # to make it available to the world in a canonical place:
       # https://spec.matrix.org/latest/client-server-api/api.json
@@ -234,13 +230,10 @@ jobs:
           name: openapi-artifact
       - name: "📝 Unpack the OpenAPI definitions in the right location"
         run: |
-          tar -C "spec${baseURL}" --strip-components=1 -xzf openapi.tar.gz
+          tar -xzf openapi.tar.gz
 
       - name: "📦 Tarball creation"
-        run: |
-          cd spec
-          tar -czf ../spec.tar.gz *
-
+        run: tar -czf spec.tar.gz spec
       - name: "📤 Artifact upload"
         uses: actions/upload-artifact@v4
         with:
@@ -269,9 +262,14 @@ jobs:
           name: spec-artifact
 
       - name: "📝 Unpack the spec"
+        # we have to unpack it into the right path given the baseurl, so that the
+        # links are correct.
+        # eg if baseurl is `/unstable`, we want to put the site in `spec/unstable`.
         run: |
-          mkdir spec
-          tar -C spec -xvzf spec.tar.gz
+          mkdir -p "spec${baseURL}"
+          tar -C "spec${baseURL}" --strip-components=1 -xvzf spec.tar.gz
+        env:
+          baseURL: "${{ needs.calculate-baseurl.outputs.baseURL }}"
 
       - name: "Run htmltest"
         uses: wjdp/htmltest-action@master
@@ -281,10 +279,8 @@ jobs:
   build-historical-spec:
     name: "📖 Build the historical backup spec"
     runs-on: ubuntu-latest
-    needs: [calculate-baseurl, build-openapi]
+    needs: [build-openapi]
     if: ${{ startsWith(github.ref, 'refs/tags/') }}
-    env:
-      baseURL: "${{ needs.calculate-baseurl.outputs.baseURL }}"
     steps:
       - name: "➕ Setup Node"
         uses: actions/setup-node@v4
@@ -304,8 +300,9 @@ jobs:
       - name: "⚙️ hugo"
         env:
           HUGO_PARAMS_VERSION_STATUS: "historical"
+        # Create a baseURL like `/v1.2` out of the `v1.2` tag
         run: |
-          hugo --baseURL "${baseURL}" -d "spec${baseURL}"
+          hugo --baseURL "/${GITHUB_REF/refs\/tags\//}" -d "spec"
 
       - name: "📥 Spec definition download"
         uses: actions/download-artifact@v4
@@ -313,12 +310,10 @@ jobs:
           name: openapi-artifact
       - name: "📝 Unpack the OpenAPI definitions in the right location"
         run: |
-          tar -C "spec${baseURL}" --strip-components=1 -xzf openapi.tar.gz
+          tar -xzf openapi.tar.gz
 
       - name: "📦 Tarball creation"
-        run: |
-          cd spec
-          tar -czf ../spec-historical.tar.gz *
+        run: tar -czf spec-historical.tar.gz spec
 
       - name: "📤 Artifact upload"
         uses: actions/upload-artifact@v4

.github/workflows/netlify.yaml

@@ -45,9 +45,7 @@ jobs:
           name: spec-artifact
 
       - name: "📦 Extract Artifacts"
-        run: |
-          mkdir spec
-          tar -C spec -xzvf spec.tar.gz && rm spec.tar.gz
+        run: tar -xzvf spec.tar.gz && rm spec.tar.gz
         
       - name: "📤 Deploy to Netlify"
         id: netlify

changelogs/internal/newsfragments/2222.clarification

@@ -1 +0,0 @@
-Clarify vendor prefixing requirements.

changelogs/internal/newsfragments/2276.feature

@@ -1 +0,0 @@
-Include the spec release version in the filenames in the tarballs generated by CI.

changelogs/internal/newsfragments/2287.clarification

@@ -1 +0,0 @@
-Upgrade to docsy v0.13.0.

changelogs/internal/newsfragments/2289.clarification

@@ -1 +0,0 @@
-Updates to the release documentation.

changelogs/server_server/newsfragments/2288.clarification

@@ -1 +0,0 @@
-Specify that callers of `/_matrix/federation/v1/openid/userinfo` must validate the returned user ID.

content/proposals.md

@@ -408,9 +408,41 @@ development or testing data.
 that a particular MSC works) do not have to follow this process.
 
 1.  Have an idea for a feature.
-1.  Implement the feature using [unstable endpoints, vendor prefixes, and
-    unstable feature flags](#unstable-endpoints-features-and-vendor-prefixes)
-    as appropriate.
+1.  Implement the feature using unstable endpoints, vendor prefixes, and
+    unstable feature flags as appropriate.
+    -   When using unstable endpoints, they MUST include a vendor
+        prefix. For example:
+        `/_matrix/client/unstable/com.example/login`. Vendor prefixes
+        throughout Matrix always use the Java package naming convention.
+        The MSC for the feature should identify which preferred vendor
+        prefix is to be used by early adopters.
+    -   Note that unstable namespaces do not automatically inherit
+        endpoints from stable namespaces: for example, the fact that
+        `/_matrix/client/r0/sync` exists does not imply that
+        `/_matrix/client/unstable/com.example/sync` exists.
+    -   If the client needs to be sure the server supports the feature,
+        an unstable feature flag that MUST be vendor prefixed is to be
+        used. This kind of flag shows up in the `unstable_features`
+        section of `/versions` as, for example, `com.example.new_login`.
+        The MSC for the feature should identify which preferred feature
+        flag is to be used by early adopters.
+    -   When using this approach correctly, the implementation can
+        ship/release the feature at any time, so long as the
+        implementation is able to accept the technical debt that results
+        from needing to provide adequate backwards and forwards
+        compatibility. The implementation MUST support the flag (and
+        server-side implementation) disappearing and be generally safe
+        for users. Note that implementations early in the MSC review
+        process may also be required to provide backwards compatibility
+        with earlier editions of the proposal.
+    -   If the implementation cannot support the technical debt (or if
+        it's impossible to provide forwards/backwards compatibility -
+        e.g. a user authentication change which can't be safely rolled
+        back), the implementation should not attempt to implement the
+        feature and should instead wait for a spec release.
+    -   If at any point after early release, the idea changes in a
+        backwards-incompatible way, the feature flag should also change
+        so that implementations can adapt as needed.
 1.  In parallel, or ahead of implementation, open an MSC and solicit
     review per above.
 1.  Before FCP can be called, the Spec Core Team will require evidence
@@ -420,7 +452,10 @@ that a particular MSC works) do not have to follow this process.
     forwards/backwards compatibility concerns mentioned here.
 1.  The FCP process is completed, and assuming nothing is flagged the
     MSC lands.
-1.  Implementations can now switch to using stable prefixes, assuming that the change
+1.  Implementations can now switch to using stable prefixes
+    (for example, for an endpoint, moving from
+    `/unstable/org.matrix.mscxxxx/frobnicate`
+    to `/v1/frobnicate`), assuming that the change
     is backwards compatible with older implementations. In the rare occasion
     where backwards compatibility is not possible without a new spec release,
     implementations should continue to use unstable prefixes.
@@ -436,6 +471,13 @@ that a particular MSC works) do not have to follow this process.
     started supporting the new spec release, some noise should be raised
     in the general direction of the implementation.
 
+{{% boxes/note %}}
+MSCs MUST still describe what the stable endpoints/feature looks like
+with a note towards the bottom for what the unstable feature
+flag/prefixes are. For example, an MSC would propose `/_matrix/client/r0/new/endpoint`, not `/_matrix/client/unstable/
+com.example/new/endpoint`.
+{{% /boxes/note %}}
+
 In summary:
 
 -   Implementations MUST NOT use stable endpoints before the MSC has
@@ -447,90 +489,14 @@ In summary:
 -   Implementations SHOULD be wary of the technical debt they are
     incurring by moving faster than the spec.
 -   The vendor prefix is chosen by the developer of the feature, using
-    the Java package naming convention.
+    the Java package naming convention. The foundation's preferred
+    vendor prefix is `org.matrix`.
 -   The vendor prefixes, unstable feature flags, and unstable endpoints
     should be included in the MSC, though the MSC MUST be written in a
     way that proposes new stable endpoints. Typically this is solved by
     a small table at the bottom mapping the various values from stable
     to unstable.
 
-#### Unstable endpoints, features and vendor prefixes
-
-Unstable endpoints MUST use `/unstable` as the endpoint version and a
-vendor prefix in Java package naming format. For example:
-`/_matrix/client/unstable/com.example.mscxxxx/login`.
-
-{{% boxes/note %}}
-Proposal authors operating with a Matrix.org Foundation mandate SHOULD use
-a vendor prefix within the `org.matrix` namespace. This namespace is otherwise
-restricted. Authors who don't own a domain MAY use the `io.github` namespace
-instead.
-{{% /boxes/note %}}
-
-Note that unstable namespaces do not automatically inherit endpoints from
-stable namespaces: for example, the fact that `/_matrix/client/v3/sync`
-exists does not imply that `/_matrix/client/unstable/com.example.mscxxxx/sync`
-exists.
-
-Vendor prefixes MUST also be used for:
-
--   New parameters on existing endpoints. For example:
-    `/_matrix/client/v3/publicRooms?com.example.mscxxxx.ordered_by=member_count`.
--   New properties in existing JSON objects. For example:
-
-    ```json
-    {
-      "avatar_url": "mxc://matrix.org/SDGdghriugerRg",
-      "displayname": "Alice Margatroid",
-      "com.example.mscxxxx.phone": [{
-        "type": "landline",
-        "number": "+1-206-555-7000"
-      }],
-      ...
-    }
-    ```
-
--   New values for existing parameters or properties. For example:
-
-    ```json
-    {
-      "errcode": "COM.EXAMPLE.MSCXXXX.M_INVALID_EMAIL",
-      "error": "The email address you provided is invalid."
-    }
-    ```
-
-If the client needs to be sure the server supports the feature, an
-unstable feature flag that MUST also be vendor prefixed is to be used.
-This flag shows up in the `unstable_features` section of
-[`/_matrix/client/versions`](/client-server-api/#get_matrixclientversions)
-as, for example, `com.example.mscxxxx.new_login`.
-
-{{% boxes/note %}}
-MSCs MUST still describe what the stable endpoints/feature looks like
-with a note towards the bottom for what the unstable feature
-flag/prefixes are. For example, an MSC would propose `/_matrix/client/v1/new/endpoint`,
-not `/_matrix/client/unstable/com.example.mscxxxx/new/endpoint`.
-{{% /boxes/note %}}
-
-When using this approach correctly, the implementation can release
-the feature at any time, so long as the implementation is able to
-accept the technical debt that results from needing to provide
-adequate backwards and forwards compatibility. The implementation
-MUST support the flag (and server-side implementation) disappearing
-and be generally safe for users. Note that implementations early in
-the MSC review process may also be required to provide backwards
-compatibility with earlier editions of the proposal.
-
-If the implementation cannot support the technical debt (or if it's
-impossible to provide forwards/backwards compatibility - e.g. a user
-authentication change which can't be safely rolled back), the
-implementation should not attempt to implement the feature and should
-instead wait for a spec release.
-
-If at any point after early release, the idea changes in a
-backwards-incompatible way, the feature flag should also change so
-that implementations can adapt as needed.
-
 ### Placeholder MSCs
 
 Some proposals may contain security-sensitive or private context which can't be

data/api/server-server/openid.yaml

@@ -43,12 +43,7 @@ paths:
                 properties:
                   sub:
                     type: string
-                    description: |
-                      The Matrix User ID who generated the token.
-
-                      The caller MUST validate that the returned user ID is on the server they
-                      called (i.e. if you make a request to example.com and it returns
-                      `@alice:matrix.org`, the result is invalid).
+                    description: The Matrix User ID who generated the token.
                     example: "@alice:example.com"
                 required:
                   - sub

go.mod

@@ -2,4 +2,6 @@ module github.com/matrix-org/matrix-spec
 
 go 1.12
 
-require github.com/matrix-org/docsy v0.0.0-20260106184755-71d103ebb20a // indirect
+require github.com/matrix-org/docsy v0.0.0-20250722140156-5df72519f5af // indirect
+
+replace github.com/matrix-org/docsy => github.com/zecakeh/matrix-org-docsy v0.0.0-20251228152706-da15500d5e72

go.sum

@@ -1,4 +1,3 @@
 github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
-github.com/matrix-org/docsy v0.0.0-20260106184755-71d103ebb20a h1:WB3unuZJy7ewAf33sxbtEwYnC+i+Jt1sJpAR3BtzvEo=
-github.com/matrix-org/docsy v0.0.0-20260106184755-71d103ebb20a/go.mod h1:mdn1m5HJug6ZddQgrOyCrXNegbtdl5evHiqqbEQLzdI=
 github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
+github.com/zecakeh/matrix-org-docsy v0.0.0-20251228152706-da15500d5e72/go.mod h1:mdn1m5HJug6ZddQgrOyCrXNegbtdl5evHiqqbEQLzdI=

meta/releasing.md

@@ -50,6 +50,11 @@ First, can we even release the spec? This stage is mostly preparation work neede
 to ensure a consistent and reliable specification.
 
 1. Ensure `main` is committed with all the spec changes you expect to be there.
+2. Review the changelog to look for typos, wording inconsistencies, or lines which
+   can be merged. For example, "Fix typos" and "Fix spelling" can be condensed to
+   "Fix various typos throughout the specification".
+3. Do a quick skim to ensure changelogs reference the MSCs which brought the changes
+   in. They should be linked to the GitHub MSC PR (not the markdown document).
 
 ## The release
 
@@ -74,24 +79,20 @@ release.
    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. Review the changelog to look for typos, wording inconsistencies, or lines which
-      can be merged. For example, "Fix typos" and "Fix spelling" can be condensed to
-      "Fix various typos throughout the specification".
-   4. Do a quick skim to ensure changelogs reference the MSCs which brought the changes
-      in. They should be linked to the GitHub MSC PR (not the markdown document).
-   5. Commit the result.
-   6. Now is a good time to have someone else review the changelog.
+   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.
 7. GitHub Actions will run its build steps. Wait until these are successful. If fixes
    need to be made to repair the pipeline or spec build, delete and re-tag the release.
    You may need to fix up the changelog file by hand in this case.
-8. GitHub Actions should have drafted a release based on the new tag. Find it
-   at https://github.com/matrix-org/matrix-spec/releases.
-   1. Double-check the generated release notes, and check that `spec-artifact.zip` and
-      `spec-historical-artifact.zip` are both attached to the draft release.
-   2. Publish the draft release.
-9. Check out and fast-forward `main` to the release branch.
+8. Check out and fast-forward `main` to the release branch.
+9. Create a new release on GitHub from the newly created tag.
+   * The title should be just "v1.2" (for example).
+   * The description should be a copy/paste of the changelog. The generated changelog
+     will be at `content/changelog/v1.2.md` - copy/paste verbatim.
+   * 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/_default/hugo.toml` on `main`:
     ```toml
     [params.version]
@@ -102,8 +103,7 @@ release.
     ```
 11. Push pending commits and ensure the unstable spec updates accordingly from the
     GitHub Actions pipeline.
-12. Deploy the release on the webserver. See "Spec release process" in the
-    internal handbook.
+12. Deploy the release on the webserver. See internal wiki.
 
 ## Patching a release