chore(deps): bump openapi-docs to v5 (plugin + theme) and Docusaurus to 3.10.1#1119
Open
dkrizan wants to merge 2 commits into
Open
chore(deps): bump openapi-docs to v5 (plugin + theme) and Docusaurus to 3.10.1#1119dkrizan wants to merge 2 commits into
dkrizan wants to merge 2 commits into
Conversation
…to 3.10.1 Dependabot #1103 bumped only docusaurus-plugin-openapi-docs to v5, leaving docusaurus-theme-openapi-docs on v4. The mismatched pair crashed every API reference page at runtime with "getQualifierMessage is not a function". - Bump docusaurus-plugin-openapi-docs and docusaurus-theme-openapi-docs to ^5.0.2 (they must share a major version) - Bump @docusaurus/* to ^3.10.1, required by the v5 theme's peer range (^3.10.0); the v5 Tabs component uses useTabsContextValue, added in 3.10 - Drop useKeyboardNavigation from the swizzled Layout; Docusaurus 3.10 removed the hook in favour of native :focus-visible - Regenerate the api/ docs with the v5 plugin (params now externalised to sidecar JSON, Translate components) Supersedes #1103. Build and all API pages verified locally.
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The v5 build peaks at ~5 GB heap and aborts on Netlify with exit code 134. Set NODE_OPTIONS=--max-old-space-size=6144 so the deploy-preview/production builds have enough headroom.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Dependabot #1103 bumped only
docusaurus-plugin-openapi-docsto v5, leaving its paireddocusaurus-theme-openapi-docson v4. These two packages must share a major version — the mismatch crashed every API reference page at runtime:(e.g.
/api/revoke-permission). The build and Netlify deploy-preview went green because the failure is client-side, not at build time — so #1103 looked safe but shipped broken docs.What
docusaurus-plugin-openapi-docsanddocusaurus-theme-openapi-docsto^5.0.2.@docusaurus/*to^3.10.1. The v5 theme's peer range is^3.10.0, and itsTabscomponent usesuseTabsContextValue, which was added in Docusaurus 3.10 (3.9.2 →useTabsContextValue is not a function).useKeyboardNavigationfrom the swizzledsrc/theme/Layout. Docusaurus 3.10 removed that hook (replaced by native:focus-visible); keeping it threwuseKeyboardNavigation is not a function.api/docs with the v5 plugin. v5 externalises params/schemas into sidecar JSON files and uses<Translate>components, hence the large generated diff.Verification
npm run buildsucceeds (all API pages render in SSG).npm run eslintandnpm run prettier-checkpass./api/revoke-permissionin a browser — page renders fully (Path Parameters,required/int64qualifiers, Responses, try-it controls) with nogetQualifierMessageerror.Supersedes #1103 — that PR should be closed in favour of this one.