Skip to content

docs: improve .changesets for v11.15.0 release - #7720

Merged
aloisklink merged 8 commits into
mermaid-js:release/11.15.0from
aloisklink:docs/improve-changesets-for-v11.15.0-release
May 7, 2026
Merged

aloisklink merged 8 commits into
mermaid-js:release/11.15.0from
aloisklink:docs/improve-changesets-for-v11.15.0-release

Conversation

@aloisklink

@aloisklink aloisklink commented May 6, 2026 •

Copy link
Copy Markdown
Member

📑 Summary

Note

This PR targets the release/11.15.0 branch!

Cleans up the .changeset files to prepare for the v11.15.0 release.

📏 Design Decisions

Please see the git log and commits for details of each change, but to summarize:

  • I've removed/added changesets that only touched @mermaid-js/parser or didn't touch mermaid, so they're only mentioned in their relevant CHANGELOG.md
  • I've removed the event modelling changesets except for just the feat: add Event Modeling diagram changeset. It doesn't make sense to have changesets saying that we've updated event modelling, when the event modelling diagram hasn't been released yet.
  • I've removed the @mermaid-js/mermaid-local-editor changeset, since it's a private package. Edit: Dropped now that we're targeting the release/11.15.0 branch that doesn't include this PR.
  • I've added diagram prefixes to most changesets that only touch one diagram, e.g. instead of having feat: add XYZ feature to flowcharts, I've standardized them to feat(flowchart): add XYZ feature to flowcharts. This also means that we are always mentioning which diagram types are affected by a fix/feature.
    • Personally, I think this is cleaner and easier to understand, but this one is a bit personal preference, so I'd understand if you want to change it. If you like it, we could even update the changeset instructions to encourage this.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

@netlify

netlify Bot commented May 6, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit a852071
🔍 Latest deploy log https://app.netlify.com/projects/mermaid-js/deploys/69fc5b7f4f1db90007f35c25
😎 Deploy Preview https://deploy-preview-7720--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@changeset-bot

changeset-bot Bot commented May 6, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a852071

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
mermaid Minor
@mermaid-js/layout-tidy-tree Patch
@mermaid-js/mermaid-zenuml Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@pkg-pr-new

pkg-pr-new Bot commented May 6, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

@mermaid-js/examples

npm i https://pkg.pr.new/@mermaid-js/examples@7720

mermaid

npm i https://pkg.pr.new/mermaid@7720

@mermaid-js/layout-elk

npm i https://pkg.pr.new/@mermaid-js/layout-elk@7720

@mermaid-js/layout-tidy-tree

npm i https://pkg.pr.new/@mermaid-js/layout-tidy-tree@7720

@mermaid-js/mermaid-zenuml

npm i https://pkg.pr.new/@mermaid-js/mermaid-zenuml@7720

@mermaid-js/parser

npm i https://pkg.pr.new/@mermaid-js/parser@7720

@mermaid-js/tiny

npm i https://pkg.pr.new/@mermaid-js/tiny@7720

commit: a852071

@codecov

codecov Bot commented May 6, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (release/11.15.0@91b1ccf). Learn more about missing BASE report.

Additional details and impacted files

Impacted file tree graph

@@                Coverage Diff                @@
##             release/11.15.0   #7720   +/-   ##
=================================================
  Coverage                   ?   3.30%           
=================================================
  Files                      ?     561           
  Lines                      ?   58355           
  Branches                   ?     873           
=================================================
  Hits                       ?    1928           
  Misses                     ?   56427           
  Partials                   ?       0           
Flag Coverage Δ
unit 3.30% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@knsv

knsv commented May 7, 2026

Copy link
Copy Markdown
Collaborator

I think conventions are good. We could group the things that are not related to Mermaid itself. Like the local editor. It's important, though, to see clearly what has changed in the Mermaid library, so that's an improvement, I'd say. Good job.

@knsv

knsv commented May 7, 2026

Copy link
Copy Markdown
Collaborator

@pbrolin47 @ashishjain0512 when you work with the release, you might want to make sure this one is included.

aloisklink added 8 commits May 7, 2026 18:29
Event modelling diagrams have not yet been released, so we don't need
any separate changesets that mention event modelling.

Unfortunately, we can't make a single changeset entry with multiple
PRs/commits, but we can at least make a single changeset with multiple
authors.

Fixes: d50c423
Fixes: 32c257e
This changeset did not mention it had anything to do with state
diagrams.

Fixes: bfe60cc
Update the changeset for
0aca217 (Make changes to allow for decimal values for sequence numbers, added corresponding unit tests, and updated docs., 2025-11-18)
to mention that it's for sequence diagrams.

I've also updated the changeset to point to
0aca217 directly, since the changeset
was generated in a different PR from the rest of the changes.

Fixes: 50b2166
This change/PR doesn't touch mermaid, so there's no reason to patch it.

Fixes: 5ab4693
45a9498 (fix: improve zenuml print rendering, sizing, and syntax resilience, 2026-04-22)
only ever modifies the `packages/mermaid-zenuml` directory.
It makes no changes to the `mermaid` package.

See: 45a9498
Since this is a docs-site only change, this won't affect consumers
of Mermaid and we probably don't need a changeset for this.

Fixes: 48424ae
The changeset for removing `%` comments in state diagrams didn't mention
they were for state diagrams. It also didn't mention migration steps.

Fixes: 8c1a0c1
Instead of having `fix: .......`, I've changed the changesets to
`fix(diagram): ......` to make it a bit easier to quickly see the
diagram types that you are interested in.
@aloisklink
aloisklink force-pushed the docs/improve-changesets-for-v11.15.0-release branch from aa350ed to a852071 Compare May 7, 2026 09:29
@aloisklink
aloisklink changed the base branch from develop to release/11.15.0 May 7, 2026 09:29
@aloisklink
aloisklink merged commit e89cae6 into mermaid-js:release/11.15.0 May 7, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants