Merge f95dcfb0e7 into 5a9f3c3bca

.github/workflows/main.yml

@@ -195,8 +195,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
@@ -219,10 +217,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
@@ -233,13 +229,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: |
+        run: tar -czf spec.tar.gz spec
-          cd spec
-          tar -czf ../spec.tar.gz *
-
       - name: "📤 Artifact upload"
         uses: actions/upload-artifact@v4
         with:
@@ -268,9 +261,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
+          mkdir -p "spec${baseURL}"
-          tar -C spec -xvzf spec.tar.gz
+          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
@@ -280,10 +278,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
@@ -303,8 +299,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
@@ -312,12 +309,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: |
+        run: tar -czf spec-historical.tar.gz spec
-          cd spec
-          tar -czf ../spec-historical.tar.gz *
 
       - name: "📤 Artifact upload"
         uses: actions/upload-artifact@v4

.github/workflows/netlify.yaml

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

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/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.

data/api/server-server/openid.yaml

@@ -43,12 +43,7 @@ paths:
                 properties:
                   sub:
                     type: string
-                    description: |
+                    description: The Matrix User ID who generated the token.
-                      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).
                     example: "@alice:example.com"
                 required:
                   - sub

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
+   3. Commit the result.
-      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.
 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
+8. Check out and fast-forward `main` to the release branch.
-   at https://github.com/matrix-org/matrix-spec/releases.
+9. Create a new release on GitHub from the newly created tag.
-   1. Double-check the generated release notes, and check that `spec-artifact.zip` and
+   * The title should be just "v1.2" (for example).
-      `spec-historical-artifact.zip` are both attached to the draft release.
+   * The description should be a copy/paste of the changelog. The generated changelog
-   2. Publish the draft release.
+     will be at `content/changelog/v1.2.md` - copy/paste verbatim.
-9. Check out and fast-forward `main` to the release branch.
+   * 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
+12. Deploy the release on the webserver. See internal wiki.
-    internal handbook.
 
 ## Patching a release