Compare commits

...

4 commits

Author SHA1 Message Date
Richard van der Hoff 60c2bab2fb
Merge 4a1af15895 into 690c41e33b 2025-12-30 21:32:09 +02:00
Kim Brose 690c41e33b
Remove unintended TeX formatting (#2283)
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
2025-12-30 19:24:38 +00:00
Kim Brose d55acfda2e
Update non-historic mentions of matrix-doc repo to matrix-spec(-proposals) (#2280) 2025-12-30 19:20:39 +00:00
Richard van der Hoff 4a1af15895 Include spec release in filenames in built tarball
It's slightly confusing that everything just ends up under `spec/`, so let's
put the version number in there
2025-12-19 00:50:24 +00:00
11 changed files with 32 additions and 22 deletions

View file

@ -195,6 +195,8 @@ jobs:
needs: [calculate-baseurl, build-openapi, generate-changelog] needs: [calculate-baseurl, build-openapi, generate-changelog]
# run even if generate-changelog was skipped # run even if generate-changelog was skipped
if: ${{ always() }} if: ${{ always() }}
env:
baseURL: "${{ needs.calculate-baseurl.outputs.baseURL }}"
steps: steps:
- name: " Setup Node" - name: " Setup Node"
uses: actions/setup-node@v4 uses: actions/setup-node@v4
@ -217,8 +219,10 @@ jobs:
with: with:
name: changelog-artifact name: changelog-artifact
path: content/changelog path: content/changelog
- name: "⚙️ hugo" - name: "⚙️ hugo"
run: hugo --baseURL "${{ needs.calculate-baseurl.outputs.baseURL }}" -d "spec" run: hugo --baseURL "${baseURL}" -d "spec${baseURL}"
# We manually unpack the spec OpenAPI definition JSON to the website tree # We manually unpack the spec OpenAPI definition JSON to the website tree
# to make it available to the world in a canonical place: # to make it available to the world in a canonical place:
# https://spec.matrix.org/latest/client-server-api/api.json # https://spec.matrix.org/latest/client-server-api/api.json
@ -229,10 +233,13 @@ jobs:
name: openapi-artifact name: openapi-artifact
- name: "📝 Unpack the OpenAPI definitions in the right location" - name: "📝 Unpack the OpenAPI definitions in the right location"
run: | run: |
tar -xzf openapi.tar.gz tar -C "spec${baseURL}" --strip-components=1 -xzf openapi.tar.gz
- name: "📦 Tarball creation" - name: "📦 Tarball creation"
run: tar -czf spec.tar.gz spec run: |
cd spec
tar -czf ../spec.tar.gz *
- name: "📤 Artifact upload" - name: "📤 Artifact upload"
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v4
with: with:
@ -253,14 +260,9 @@ jobs:
name: spec-artifact name: spec-artifact
- name: "📝 Unpack the spec" - 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: | run: |
mkdir -p "spec${baseURL}" mkdir spec
tar -C "spec${baseURL}" --strip-components=1 -xvzf spec.tar.gz tar -C spec -xvzf spec.tar.gz
env:
baseURL: "${{ needs.calculate-baseurl.outputs.baseURL }}"
- name: "Run htmltest" - name: "Run htmltest"
uses: wjdp/htmltest-action@master uses: wjdp/htmltest-action@master
@ -270,8 +272,10 @@ jobs:
build-historical-spec: build-historical-spec:
name: "📖 Build the historical backup spec" name: "📖 Build the historical backup spec"
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: [build-openapi] needs: [calculate-baseurl, build-openapi]
if: ${{ startsWith(github.ref, 'refs/tags/') }} if: ${{ startsWith(github.ref, 'refs/tags/') }}
env:
baseURL: "${{ needs.calculate-baseurl.outputs.baseURL }}"
steps: steps:
- name: " Setup Node" - name: " Setup Node"
uses: actions/setup-node@v4 uses: actions/setup-node@v4
@ -291,9 +295,8 @@ jobs:
- name: "⚙️ hugo" - name: "⚙️ hugo"
env: env:
HUGO_PARAMS_VERSION_STATUS: "historical" HUGO_PARAMS_VERSION_STATUS: "historical"
# Create a baseURL like `/v1.2` out of the `v1.2` tag
run: | run: |
hugo --baseURL "/${GITHUB_REF/refs\/tags\//}" -d "spec" hugo --baseURL "${baseURL}" -d "spec${baseURL}"
- name: "📥 Spec definition download" - name: "📥 Spec definition download"
uses: actions/download-artifact@v4 uses: actions/download-artifact@v4
@ -301,10 +304,12 @@ jobs:
name: openapi-artifact name: openapi-artifact
- name: "📝 Unpack the OpenAPI definitions in the right location" - name: "📝 Unpack the OpenAPI definitions in the right location"
run: | run: |
tar -xzf openapi.tar.gz tar -C "spec${baseURL}" --strip-components=1 -xzf openapi.tar.gz
- name: "📦 Tarball creation" - name: "📦 Tarball creation"
run: tar -czf spec-historical.tar.gz spec run: |
cd spec
tar -czf ../spec-historical.tar.gz *
- name: "📤 Artifact upload" - name: "📤 Artifact upload"
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v4
with: with:

View file

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

View file

@ -0,0 +1 @@
Update non-historic mentions of matrix-doc repo to matrix-spec/-proposals. Contributed by @HarHarLinks.

View file

@ -0,0 +1 @@
Remove unintended TeX formatting. Contributed by @HarHarLinks.

View file

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

View file

@ -87,7 +87,7 @@ Matrix 1.12 is expected to be released in the July-September 2024 calendar quart
The homeserver SHOULD be able to supply thumbnails for uploaded images The homeserver SHOULD be able to supply thumbnails for uploaded images
and videos. The exact file types which can be thumbnailed are not and videos. The exact file types which can be thumbnailed are not
currently specified - see [Issue currently specified - see [Issue
\#1938](https://github.com/matrix-org/matrix-doc/issues/1938) for more \#1938](https://github.com/matrix-org/matrix-spec/issues/453) for more
information. information.
The thumbnail methods are "crop" and "scale". "scale" tries to return an The thumbnail methods are "crop" and "scale". "scale" tries to return an

View file

@ -921,7 +921,7 @@ collaborate to create a common set of translations for all languages.
{{% boxes/note %}} {{% boxes/note %}}
Known translations for the emoji are available from Known translations for the emoji are available from
<https://github.com/matrix-org/matrix-doc/blob/master/data-definitions/> <https://github.com/matrix-org/matrix-spec/tree/main/data-definitions/>
and can be translated online: and can be translated online:
<https://translate.riot.im/projects/matrix-doc/sas-emoji-v1> <https://translate.riot.im/projects/matrix-doc/sas-emoji-v1>
{{% /boxes/note %}} {{% /boxes/note %}}

View file

@ -119,7 +119,7 @@ Clients SHOULD verify the structure of incoming events to ensure that
the expected keys exist and that they are of the right type. Clients can the expected keys exist and that they are of the right type. Clients can
discard malformed events or display a placeholder message to the user. discard malformed events or display a placeholder message to the user.
Redacted `m.room.message` events MUST be removed from the client. This Redacted `m.room.message` events MUST be removed from the client. This
can either be replaced with placeholder text (e.g. "\[REDACTED\]") or can either be replaced with placeholder text (e.g. "[REDACTED]") or
the redacted message can be removed entirely from the messages view. the redacted message can be removed entirely from the messages view.
Events which have attachments (e.g. `m.image`, `m.file`) SHOULD be Events which have attachments (e.g. `m.image`, `m.file`) SHOULD be

View file

@ -223,7 +223,7 @@ paths:
type: string type: string
# XXX: As mentioned in MSC1227, replacing `[not_]membership` with a JSON # XXX: As mentioned in MSC1227, replacing `[not_]membership` with a JSON
# filter might be a better alternative. # filter might be a better alternative.
# See https://github.com/matrix-org/matrix-doc/issues/1337 # See https://github.com/matrix-org/matrix-doc/issues/1227
- in: query - in: query
name: membership name: membership
description: |- description: |-

View file

@ -78,7 +78,7 @@ paths:
}, },
"room": { "room": {
"regexp": "[^\\s]+\\/[^\\s]+", "regexp": "[^\\s]+\\/[^\\s]+",
"placeholder": "matrix-org/matrix-doc" "placeholder": "matrix-org/matrix-spec"
} }
}, },
"instances": [ "instances": [

View file

@ -6,7 +6,7 @@
* in the specification. * in the specification.
* *
* In detail, it: * In detail, it:
* - fetches all GitHub issues from matrix-doc that have the `proposal` label * - fetches all GitHub issues from matrix-spec-proposals that have the `proposal` label
* - groups them by their state in the MSC process * - groups them by their state in the MSC process
* - does some light massaging of them so it's easier for the Hugo template to work with them * - does some light massaging of them so it's easier for the Hugo template to work with them
* - store them at /data/msc * - store them at /data/msc