Skip to content

chore: pin @camunda8/openapi-docs to ^4.6.5#8574

Merged
jwulf merged 2 commits intomainfrom
chore/bump-openapi-docs-4.6.5
Apr 13, 2026
Merged

chore: pin @camunda8/openapi-docs to ^4.6.5#8574
jwulf merged 2 commits intomainfrom
chore/bump-openapi-docs-4.6.5

Conversation

@emilyoram
Copy link
Copy Markdown
Contributor

@emilyoram emilyoram commented Apr 13, 2026

Summary

Temporary pin until we upgrade to Docusaurus 3.10.0 + @camunda8/*@5.x.

Changes

  • Pin @camunda8/docusaurus-plugin-openapi-docs and @camunda8/docusaurus-theme-openapi-docs to ^4.6.5

Why

Docusaurus 3.10.0 refactored the Tabs API (useTabs(props)useTabsContextValue(props) + useTabs()). The @camunda8 4.x theme code calls the old useTabs(props), which in 3.10.0 is now a context consumer (no args) — causing useTabsContext() must be used within a Tabs component errors that crash SSG on all 482+ API spec pages.

The @camunda8 4.x packages declare peerDependencies: <3.10.0 for @docusaurus/*, so npm will warn if Docusaurus is bumped to 3.10.0 while still on 4.x.

What happens next

The @camunda8 fork has a 5.x stream (on main) that includes the upstream v5.0.0 merge with the Tabs API migration and requires Docusaurus >=3.10.0. Once we're ready to upgrade Docusaurus to 3.10.0, switch to @camunda8/*@5.x:

- "@camunda8/docusaurus-plugin-openapi-docs": "^4.6.5",
- "@camunda8/docusaurus-theme-openapi-docs": "^4.6.5",
+ "@camunda8/docusaurus-plugin-openapi-docs": "^5.0.1",
+ "@camunda8/docusaurus-theme-openapi-docs": "^5.0.1",
Stream Version Docusaurus compat npm tag
4.x (stable/4.x) 4.6.5 >=3.5.0 <3.10.0 legacy
5.x (main) 5.0.1 ^3.10.0 latest

Temporary constraints until we upgrade to Docusaurus 3.10.0:

- Pin @camunda8/docusaurus-plugin-openapi-docs and
  @camunda8/docusaurus-theme-openapi-docs to ~4.6.5 (the 4.x stream with
  peerDeps capped at <3.10.0).
- Cap @docusaurus/* packages at <3.10.0 to prevent Renovate from pulling
  3.10.0, which breaks SSG due to a Tabs API refactor
  (useTabs -> useTabsContextValue).

Once we're ready for Docusaurus 3.10.0, switch to @camunda8/*@5.x which
includes the upstream v5.0.0 merge with the Tabs API migration.
@emilyoram emilyoram force-pushed the chore/bump-openapi-docs-4.6.5 branch from 777ac1c to 003d2a8 Compare April 13, 2026 22:33
@emilyoram emilyoram changed the title chore: pin @camunda8/openapi-docs to 4.6.5, cap Docusaurus <3.10.0 chore: pin @camunda8/openapi-docs to ~4.6.5 Apr 13, 2026
jwulf
jwulf previously approved these changes Apr 13, 2026
Temporary pin until we upgrade to Docusaurus 3.10.0 + @camunda8/*@5.x.

The @camunda8 4.x packages declare peerDependencies <3.10.0 for Docusaurus,
which will warn on mismatch if Docusaurus is bumped independently.
@emilyoram emilyoram force-pushed the chore/bump-openapi-docs-4.6.5 branch from 003d2a8 to 1eb29cd Compare April 13, 2026 22:48
@emilyoram emilyoram changed the title chore: pin @camunda8/openapi-docs to ~4.6.5 chore: pin @camunda8/openapi-docs to ^4.6.5 Apr 13, 2026
@jwulf jwulf enabled auto-merge April 13, 2026 22:49
@jwulf jwulf merged commit c0f8aab into main Apr 13, 2026
8 checks passed
@jwulf jwulf deleted the chore/bump-openapi-docs-4.6.5 branch April 13, 2026 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants