Skip to content

Commit cede679

Browse files
authored
ci(docs): Upgrade Docusaurus to 3.10.0, pin webpack dep and track docs/yarn.lock for deterministic CI runs (#2817)
* Upgrade docusaurus to `v3.10.0`. * Pin webpack's version down for docusaurus to avoid unprecedented packing behaviors. * Add/track `yarn.lock` for docs. * Make sure required nested apps' lock files aren't ignored.
1 parent a23b25c commit cede679

4 files changed

Lines changed: 9615 additions & 7 deletions

File tree

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,8 @@ playground/playground.tsx
3030
.buildkite/buildkite.d.ts
3131
.buildkite/artifacts/
3232

33-
# keep only top-level lock file
33+
# keep only top-level lock file unless a workspace manages its own install
3434
**/*/yarn.lock
35+
!.buildkite/yarn.lock
36+
!docs/yarn.lock
37+
!e2e/yarn.lock

docs/docusaurus.config.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,11 @@ const config: Config = {
3232
projectName: 'docusaurus', // Usually your repo name.
3333

3434
onBrokenLinks: 'warn',
35-
onBrokenMarkdownLinks: 'warn',
35+
markdown: {
36+
hooks: {
37+
onBrokenMarkdownLinks: 'warn',
38+
},
39+
},
3640

3741
// Even if you don't use internationalization, you can use this field to set
3842
// useful metadata like html lang. For example, if your site is Chinese, you

docs/package.json

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
"typecheck": "tsc -p ./tsconfig.json --noEmit"
1717
},
1818
"dependencies": {
19-
"@docusaurus/core": "^3.2.1",
20-
"@docusaurus/preset-classic": "^3.2.1",
19+
"@docusaurus/core": "^3.10.0",
20+
"@docusaurus/preset-classic": "^3.10.0",
2121
"@mdx-js/react": "^3.0.0",
2222
"clsx": "^2.0.0",
2323
"docusaurus-lunr-search": "^3.3.2",
@@ -29,11 +29,14 @@
2929
"sass": "^1.69.5"
3030
},
3131
"devDependencies": {
32-
"@docusaurus/module-type-aliases": "^3.2.1",
33-
"@docusaurus/tsconfig": "^3.2.1",
34-
"@docusaurus/types": "^3.2.1",
32+
"@docusaurus/module-type-aliases": "^3.10.0",
33+
"@docusaurus/tsconfig": "^3.10.0",
34+
"@docusaurus/types": "^3.10.0",
3535
"typescript": "~5.5.3"
3636
},
37+
"resolutions": {
38+
"webpack": "5.105.1"
39+
},
3740
"browserslist": {
3841
"production": [
3942
">0.5%",

0 commit comments

Comments
 (0)