Skip to content

Commit 93cba10

Browse files
committed
fix(docs): pin builddocs to 1.x to fix api docs build
builddocs 2.x is an incompatible rewrite: the `build()` function was replaced by `buildDocs()`, which emits HTML and drops the markdown output and template support the docs script relies on. #2404 bumped it from ^1.0.8 to ^2.0.0, breaking `pnpm -F @milkdown/docs run build` with "import_builddocs.build is not a function". Pin back to ^1.0.9 and add a renovate rule to block builddocs major upgrades until the script is migrated.
1 parent 236baf4 commit 93cba10

3 files changed

Lines changed: 80 additions & 10 deletions

File tree

‎.github/renovate.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@
1919
"matchDepNames": ["prosemirror-*"],
2020
"groupName": "prosemirror"
2121
},
22+
{
23+
"matchDepNames": ["builddocs"],
24+
"description": "builddocs 2.x is an incompatible rewrite (HTML output, no markdown/templates); stay on 1.x",
25+
"matchUpdateTypes": ["major"],
26+
"enabled": false
27+
},
2228
{
2329
"groupName": "all non-major dependencies",
2430
"groupSlug": "all-minor-patch",

‎docs/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
},
1616
"devDependencies": {
1717
"@types/fs-extra": "^11.0.4",
18-
"builddocs": "^2.0.0",
18+
"builddocs": "^1.0.9",
1919
"fs-extra": "^11.3.0"
2020
}
2121
}

‎pnpm-lock.yaml‎

Lines changed: 73 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)