Michael Telatynski
e2b2e56bd2
Use NPM Trusted Publishers over token ( #2239 )
...
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
* Use NPM Trusted Publishers over token
due to security changes being enacted next month by npm
* Add changelog entry
* Update npm
2025-10-29 11:44:58 -06:00
Kévin Commaille
4d4069166d
Upgrade docsy to 0.12.0 ( #2160 )
2025-08-27 07:35:57 +01:00
Pierre 'McFly' Marty
4c87e0e745
ci(build-openapi): indentity routes were missing ( #2172 )
2025-07-22 15:13:51 +01:00
Kévin Commaille
67743d5715
Fix generation of historical spec ( #2123 )
...
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
With the move of the config file, the command in CI did not work as
expected anymore.
I am unsure why Hugo actually ignored the missing config file in the
command…
To avoid this problem in the future and simplify the job, we use the
default config and add an environment variable for the status which will
always take precedence over the config.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-05-13 16:09:18 +01:00
Kévin Commaille
fe46e0c363
Replace Hugo shortcodes in OpenAPI output ( #2088 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-05-08 09:29:32 +00:00
Kévin Commaille
d5c56a4f17
Upgrade docsy to 0.11.0 and hugo to 0.139.0 ( #1996 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-11-19 21:40:34 +00:00
Kévin Commaille
bf8dee74eb
Fix relative URLs when serving the specification with a custom baseURL ( #1984 )
2024-11-14 11:11:34 +00:00
Kévin Commaille
b1ebbb9a1c
Rename .htmltest.yaml to .htmltest.yml ( #1985 )
...
* Rename .htmltest.yaml to .htmltest.yml
This is almost nothing but htmltest expects this exact name by default, so when running the
binary locally, it avoids to have to bother with providing the name of the config file.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
---------
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-10-28 14:21:20 +00:00
Johannes Marbach
00af39ecca
Provide MD checklists for the changelog ( #1937 )
...
* Output changelog checklists
Fixes : #1682
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-09-27 13:00:00 +01:00
davidegirardi
eb49b28ea9
Use environment variables in workflow ( #1865 )
...
* Use environment variables in workflow
* Add newsfragment
2024-06-12 14:14:37 +01:00
Kévin Commaille
784b8984f3
Generate ToC with Hugo rather than JavaScript ( #1851 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-06-11 22:24:23 +01:00
Kévin Commaille
ae70b5fcf3
Replace set-output with environment files in CI ( #1806 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-04-30 17:02:59 +01:00
Kévin Commaille
d3eca87389
Set python version for the Towncrier CI job ( #1805 )
...
Otherwise the version might change depending on the runner.
We just use the same version as other jobs.
This removes a GitHub warning.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2024-04-30 16:01:18 +00:00
Kévin Commaille
d6b1d7300f
Update most CI actions ( #1803 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-04-30 16:57:20 +01:00
Kévin Commaille
b0115a9613
Update typos CI action ( #1804 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-04-30 16:56:03 +01:00
Kévin Commaille
1095179374
Upgrade version of Hugo used to build the spec in CI ( #1794 )
...
* Upgrade version of Hugo used to build the spec in CI
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Escape HTML manually in property-type partial
The behavior of `delimit` changed,
so Hugo doesn't recognize "safe" HTML passed to it anymore, so it escapes nested HTML links.
To fix that we escape the schema data manually
and consider the output of the partial as "safe".
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
---------
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-04-23 16:30:21 +01:00
Michael Telatynski
083e6ef25d
Fix npm publishing being broken in CI ( #1765 )
...
* Fix `v` tag_name prefix sneaking into npm version
* Fix `yarn version` failing in CI due to no git global ident name
* Add changelog
* Rename 1765.misc to 1765.clarification
2024-03-22 18:27:42 +00:00
Travis Ralston
4e51970c55
Upgrade Hugo version on the historical spec
2024-03-22 10:06:23 -06:00
Michael Telatynski
650e691a22
Fix npm release script ( #1713 )
...
* Fix npm release script
* Create 1713.misc
2024-01-17 10:16:28 -07:00
Kévin Commaille
9fe119370b
Update typos action and fix typos ( #1661 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-10-11 11:42:05 +01:00
Kévin Commaille
560d98ba9b
Add more CI checks for OpenAPI definitions and JSON Schemas ( #1656 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2023-10-11 10:36:39 +00:00
Kévin Commaille
c71b528148
Upgrade GitHub actions ( #1660 )
...
* Upgrade most github actions
Gets rid of warning in CI complaining about those actions
using node 12.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Upgrade node version used to run scripts
Use the latest LTS
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-10-11 11:23:16 +01:00
Kévin Commaille
72517c0f9c
Generate server-server OpenAPI definition ( #1657 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-10-10 18:21:38 +01:00
Michael Telatynski
f11c5600a2
Fix npm package release automation ( #1648 )
2023-09-26 18:08:02 +00:00
Kévin Commaille
99e2ff4927
Replace all mentions of Swagger by OpenAPI ( #1633 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-09-19 18:26:07 +01:00
Michael Telatynski
c0babbfc13
Create @matrix-org/spec npm package containing sas-emoji.json ( #1620 )
...
* Create packages/npm @matrix-org/spec npm package containing spec-emoji
* Initial workflow script
* Add newsfragment
* Add docs
* npm publish doesn't like symlinks, yarn does :((
2023-08-18 09:56:55 -06:00
Richard van der Hoff
b2ab339ba6
Bump hugo version used for the build ( #1591 )
...
Since https://github.com/matrix-org/matrix-spec/issues/1544 is fixed, we can
use a modern hugo.
2023-06-28 07:26:14 +01:00
Kévin Commaille
4a9bda9bed
Use tag name as the OpenAPI definition version ( #1561 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-06-20 18:20:22 +01:00
Kévin Commaille
3c5355a278
Use Redocly CLI to validate OpenAPI definitions ( #1558 )
2023-06-09 21:55:12 +03:00
Richard van der Hoff
ac8d34bc81
Cleanups to github actions workflow ( #1476 )
2023-03-29 11:16:52 +01:00
Richard van der Hoff
3c9139bd5d
Unpack spec into right place for htmltest ( #1338 )
...
Hopefully, fixes https://github.com/matrix-org/matrix-spec/issues/1336
2022-11-15 23:30:17 +00:00
Richard van der Hoff
08fde5f257
Generate unstable changelogs using towncrier ( #1340 )
...
Replace the current stack of hugo templates with a towncrier invocation. The main advantage of this is that it means that the "Changes since last release" section is consistent with the changelogs for the actual releases.
This also changes the release process so that the changelog is generated before tagging, which means that the thing tagged v1.5 is actually the v1.5 spec.
Fixes #908 .
2022-11-15 23:26:55 +00:00
Richard van der Hoff
3e074ed6d3
Add htmltest github action
2022-11-08 19:00:38 +00:00
Andrew Morgan
fd41d9d4ed
Update docsy (hugo theme) git submodule ( #1295 )
2022-11-08 17:29:10 +00:00
Richard van der Hoff
737260edbe
Move newsfragment check to a separate workflow ( #1193 )
...
... to make sure we still get a preview even if there is no newsfragment.
2022-08-02 23:44:44 +01:00
Aaron Raimist
0cec7c7f1b
Pin typos to v1.10.2 and run on pushes to main ( #1143 )
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2022-06-26 14:39:43 -06:00
Andrew Morgan
b9500a7548
Update the 'unstable' copy of the site every night at 2am UTC ( #1028 )
2022-04-12 12:52:12 -07:00
Andrew Morgan
5a54ca66d1
Replace deprecated Page.Dir with Page.File.Dir ( #988 )
2022-03-29 15:03:41 +01:00
Richard van der Hoff
dfdc840bb6
GHA job to check newsfragments. ( #990 )
2022-03-09 10:19:09 +00:00
Alexandre Franke
de9cf76a57
Dump additional apis ( #3684 )
...
* ✨ Allow JSON generation for all API
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 👷 Export AS API JSON
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* ✨ Handle missing security definitions
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 👷 Export Push Gateway API JSON
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 🎨 Improve identation
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 🐛 Fix successive reference handling
Fixes #3689
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 👷 Export Server-Server API JSON
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 📝 Remove obsolete comment
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 🐛 Make properties objects, as they MUST be
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* Revert "👷 Export Server-Server API JSON"
This reverts commit 061f91c2cbcb6dff35c74177226da106826b4214.
Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
2022-02-02 08:51:07 -07:00
Alexandre Franke
7e92964dc5
🚚 Rename OpenAPI artifact ( #3621 )
...
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
2022-01-06 09:36:06 +01:00
Travis Ralston
dfec7d687e
Remove extraneous slash
2021-12-29 10:17:26 -07:00
Alexandre Franke
6972342611
🐛 Fix base URL for OpenAPI definition ( #3602 )
...
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
2021-12-29 10:01:32 -07:00
Travis Ralston
3ebe4e801b
Fix historical spec build
2021-12-28 12:50:39 -07:00
Alexandre Franke
b55cc15772
✨ Fix links in OpenAPI description nodes ( #3598 )
...
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
2021-12-28 18:14:44 +01:00
Aaron Raimist
01cd41de68
Add GitHub Action to check spelling ( #3591 )
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2021-12-28 09:17:49 -07:00
Alexandre Franke
d25fa13e6d
💚 Update PR description editing action ( #3558 )
...
Switch to upstream and use a more recent version.
Fixes failure to edit on empty descriptions.
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
2021-12-09 09:14:03 +01:00
Alexandre Franke
806ae22da7
🚀 Make OpenAPI definition available ( #3542 )
...
* 🚀 Make OpenAPI definition available
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 💚 Fix artifact name
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 💚 Introduce dependency between jobs
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* 🚀 Make historical definitions available
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
2021-12-08 19:28:08 -07:00
Richard van der Hoff
86fb65a4bd
GHA: url-encode branch name in pull-request search ( #3541 )
2021-12-03 13:34:55 +00:00
Richard van der Hoff
0d8f466f39
Replace remaining CircleCI jobs with GHA ( #3505 )
...
Apparently the `build-docs` step is already happening, so we just need to port
the schema and example validation jobs.
2021-11-17 21:01:53 +00:00
