Skip to content

fix(docs): pin @mermaid-js/layout-elk to ^0.1.9 (fixes flaky docs build)#391

Merged
sunholo-voight-kampff merged 1 commit into
devfrom
fix/docs-mermaid-peer
Jul 14, 2026
Merged

fix(docs): pin @mermaid-js/layout-elk to ^0.1.9 (fixes flaky docs build)#391
sunholo-voight-kampff merged 1 commit into
devfrom
fix/docs-mermaid-peer

Conversation

@sunholo-voight-kampff

Copy link
Copy Markdown
Collaborator

Problem

The build CI check has been flaky since the docusaurus group bump #373. That PR moved @mermaid-js/layout-elk to ^0.2.2, but @docusaurus/theme-mermaid@3.10.2 declares:

peerOptional @mermaid-js/layout-elk: ^0.1.9

make docs-install runs npm install (not npm ci), which re-resolves peers on every run, so the conflict surfaces as an intermittent ERESOLVE failure. Evidence it's flaky, not hard-broken: #373's own commit has both a passing and a failing build check-run, and #390 failed then passed on retry.

Left unfixed, this randomly reds-out every PR's required build check and can stall the new Dependabot auto-merge (it waits for green).

Fix

@docusaurus/theme-mermaid is pinned to the docusaurus 3.10.x line, so it can't adopt a layout-elk 0.2.x peer without a full docusaurus major upgrade. Pin layout-elk back to ^0.1.9 — the version dev ran before #373 — so npm install resolves deterministically. Lockfile regenerated; npm install verified clean (no ERESOLVE), 0 remaining 0.2.2 refs.

🤖 Generated with Claude Code

…d peer

The docusaurus group bump (#373) moved @mermaid-js/layout-elk to ^0.2.2,
but @docusaurus/theme-mermaid@3.10.2 declares peerOptional
@mermaid-js/layout-elk@^0.1.9. Since docs-install runs `npm install`
(not `npm ci`), the ERESOLVE peer conflict surfaced intermittently and
made the required `build` check flaky (#373's own run shows both a pass
and a fail; #390 hit it too).

theme-mermaid is locked to the docusaurus 3.10.x line, so it can't move
to a layout-elk 0.2.x peer without a full docusaurus major upgrade.
Pin layout-elk back to ^0.1.9 (0.1.9 is the version dev ran before #373)
so npm install resolves deterministically. Regenerated package-lock.json.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@sunholo-voight-kampff
sunholo-voight-kampff enabled auto-merge (squash) July 14, 2026 10:15
@sunholo-voight-kampff
sunholo-voight-kampff merged commit 22af40d into dev Jul 14, 2026
17 checks passed
@sunholo-voight-kampff
sunholo-voight-kampff deleted the fix/docs-mermaid-peer branch July 14, 2026 10:27
sunholo-voight-kampff added a commit that referenced this pull request Jul 20, 2026
…id peer) (#435)

Dependabot #429 (9039805) bumped @mermaid-js/layout-elk ^0.1.9 → ^0.2.2,
re-introducing the exact peer-dependency conflict that #391 had previously
pinned away: @docusaurus/theme-mermaid@3.10.2 requires @mermaid-js/layout-elk
@^0.1.9, so `make docs-install` (`npm install`) fails with ERESOLVE. This reds
the Deploy-Documentation `build` job (a required check), blocking every PR whose
test-merge inherits dev's package.json.

Re-pins to ^0.1.9 and regenerates the lockfile (layout-elk resolves 0.1.9).
`cd docs && npm install` now exits 0. Mirrors #391.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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.

1 participant