Skip to content

Commit 39eb4f4

Browse files
fix(website): unbreak docusaurus build on 3.10.x (#1062)
The "Test docs deployment" CI workflow has been failing since Docusaurus 3.10 was released. Two distinct issues, fixed together so every commit on this branch keeps CI green: 1. `future.v4: true` in `docusaurus.config.ts` now routes through the rspack bundler path, which hard-requires `@docusaurus/faster` to be a direct dependency. Add it and bump all `@docusaurus/*` packages from `^3.9.2` to `^3.10.1`. Refresh other website deps within their existing ranges (no major-version jumps). 2. Docusaurus 3.10's MDX loader is stricter and rejects HTML comments (`<!-- ... -->`) in `.md` files. The git-cliff-generated patch notes contain these comments. Keep them in `cliff.toml`/`CHANGELOG.md` (so GitHub-rendered output stays clean) but transform `<!--`/`-->` to `{/*`/`*/}` in the workflow's copy step that produces `docs/developers/patch-notes.md`. Apply the same transform to the already-checked-in `patch-notes.md` and `release-notes/0.12.md`.
1 parent 8db108d commit 39eb4f4

5 files changed

Lines changed: 2518 additions & 1562 deletions

File tree

.github/workflows/changelog.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ jobs:
2828
GITHUB_REPO: ${{ github.repository }}
2929
- name: Copy changelog to docs
3030
run: |
31-
cp CHANGELOG.md 'docs/developers/patch-notes.md'
31+
# MDX (used by docusaurus) does not allow HTML comments, so rewrite
32+
# the cliff-template markers into MDX-style `{/* ... */}` comments.
33+
sed -e 's|<!--|{/*|g' -e 's|-->|*/}|g' \
34+
CHANGELOG.md > 'docs/developers/patch-notes.md'
3235
- name: Extract branch name
3336
shell: bash
3437
run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT

docs/developers/patch-notes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Changelog
22

33
All notable changes to this project will be documented in this file.
4-
<!-- ignore lint rules that are often triggered by content generated from commits / git-cliff -->
5-
<!-- markdownlint-disable line-length no-bare-urls ul-style emphasis-style -->
4+
{/* ignore lint rules that are often triggered by content generated from commits / git-cliff */}
5+
{/* markdownlint-disable line-length no-bare-urls ul-style emphasis-style */}
66

77
## [0.15.6](https://github.com/alexpasmantier/television/releases/tag/0.15.6) - 2026-04-15
88

@@ -1899,5 +1899,5 @@ All notable changes to this project will be documented in this file.
18991899
* @alexpasmantier made their first contribution
19001900

19011901

1902-
<!-- generated by git-cliff -->
1902+
{/* generated by git-cliff */}
19031903

docs/developers/release-notes/0.12.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,4 +361,4 @@ Television now has [a brand new website](https://alexpasmantier.github.io/televi
361361

362362
**Full Changelog**: https://github.com/alexpasmantier/television/compare/0.11.9...0.12.0
363363

364-
<!-- generated by git-cliff -->
364+
{/* generated by git-cliff */}

website/package.json

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,26 @@
1414
"typecheck": "tsc"
1515
},
1616
"dependencies": {
17-
"@docsearch/react": "^4.6.0",
18-
"@docusaurus/core": "^3.9.2",
19-
"@docusaurus/preset-classic": "^3.9.2",
20-
"@docusaurus/theme-common": "^3.9.2",
21-
"@docusaurus/theme-mermaid": "^3.9.2",
22-
"@docusaurus/theme-search-algolia": "^3.9.2",
17+
"@docsearch/react": "^4.6.3",
18+
"@docusaurus/core": "^3.10.1",
19+
"@docusaurus/faster": "^3.10.1",
20+
"@docusaurus/preset-classic": "^3.10.1",
21+
"@docusaurus/theme-common": "^3.10.1",
22+
"@docusaurus/theme-mermaid": "^3.10.1",
23+
"@docusaurus/theme-search-algolia": "^3.10.1",
2324
"@mdx-js/react": "^3.1.1",
2425
"clsx": "^2.1.1",
2526
"prism-react-renderer": "^2.4.1",
26-
"react": "^19.2.4",
27-
"react-dom": "^19.2.4"
27+
"react": "^19.2.6",
28+
"react-dom": "^19.2.6"
2829
},
2930
"devDependencies": {
30-
"@algolia/autocomplete-core": "^1.19.6",
31-
"@docusaurus/module-type-aliases": "^3.9.2",
32-
"@docusaurus/tsconfig": "^3.9.2",
33-
"@docusaurus/types": "^3.9.2",
31+
"@algolia/autocomplete-core": "^1.19.8",
32+
"@docusaurus/module-type-aliases": "^3.10.1",
33+
"@docusaurus/tsconfig": "^3.10.1",
34+
"@docusaurus/types": "^3.10.1",
3435
"@types/react": "^19.2.14",
35-
"algoliasearch": "^5.49.1",
36+
"algoliasearch": "^5.52.1",
3637
"typescript": "~5.9.3"
3738
},
3839
"browserslist": {

0 commit comments

Comments
 (0)