Skip to content

chore(deps): bump mermaid and @mermaid-js/layout-elk#11812

Open
anaxite wants to merge 1 commit intofacebook:mainfrom
anaxite:mermaid-elk-update
Open

chore(deps): bump mermaid and @mermaid-js/layout-elk#11812
anaxite wants to merge 1 commit intofacebook:mainfrom
anaxite:mermaid-elk-update

Conversation

@anaxite
Copy link

@anaxite anaxite commented Mar 17, 2026

Pre-flight checklist

Motivation

This pull request bumps @mermaid-js/layout-elk from 0.1.9 to 0.2.1, as the current semver rules lock it the package at 0.1.9. Due to the version bump, the minimum Mermaid version is now 11.13.0.

Test Plan

Verified with:

  • yarn jest packages/docusaurus-theme-mermaid
  • yarn workspace @docusaurus/theme-mermaid build
  • site preview

Test links

Deploy preview (if needed): https://deploy-preview-11812--docusaurus-2.netlify.app/

@meta-cla meta-cla bot added the CLA Signed Signed Facebook CLA label Mar 17, 2026
@netlify
Copy link

netlify bot commented Mar 17, 2026

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit d4933f3
🔍 Latest deploy log https://app.netlify.com/projects/docusaurus-2/deploys/69b9cdaff271340008ea8b4b
😎 Deploy Preview https://deploy-preview-11812--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't update Mermaid like that because they upgraded Langium to v4 which breaks support for Node 20.0, which we still support.

CI reports:

error langium@4.2.1: The engine "node" is incompatible with this module. Expected version ">=20.10.0". Got "20.0.0"

Anyway, I don't see any reason to force the upgrade since users can already upgrade on their own, so you can just revert it and relax the ELK range

"@docusaurus/types": "3.9.2",
"@docusaurus/utils-validation": "3.9.2",
"mermaid": ">=11.6.0",
"mermaid": ">=11.13.0",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why this needs to be bumped. People can already use newer versions

"devDependencies": {},
"peerDependencies": {
"@mermaid-js/layout-elk": "^0.1.9",
"@mermaid-js/layout-elk": "^0.2.1",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, a 0.x minor semver version can ship breaking changes, although this one doesn't ship any problematic change IMHO.
https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid-layout-elk/CHANGELOG.md#020

It's not super clear if MermaidJS commits to respecting semver because they sometimes kind-of break things in releases that shouldn't be breaking.

Since it's a peer dependency, I guess we could just use >=0.1.9 (we already use >= for mermaid anyway) and let users choose the version they want.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants