docs: improve .changesets for v11.15.0 release - #7720
aloisklink merged 8 commits into
Conversation
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🦋 Changeset detectedLatest commit: a852071 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
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 |
@mermaid-js/examples
mermaid
@mermaid-js/layout-elk
@mermaid-js/layout-tidy-tree
@mermaid-js/mermaid-zenuml
@mermaid-js/parser
@mermaid-js/tiny
commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## release/11.15.0 #7720 +/- ##
=================================================
Coverage ? 3.30%
=================================================
Files ? 561
Lines ? 58355
Branches ? 873
=================================================
Hits ? 1928
Misses ? 56427
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
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. |
|
@pbrolin47 @ashishjain0512 when you work with the release, you might want to make sure this one is included. |
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
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.
aa350ed to
a852071
Compare
📑 Summary
Note
This PR targets the
release/11.15.0branch!Cleans up the
.changesetfiles to prepare for the v11.15.0 release.📏 Design Decisions
Please see the
git logand commits for details of each change, but to summarize:@mermaid-js/parseror didn't touchmermaid, so they're only mentioned in their relevant CHANGELOG.mdfeat: add Event Modeling diagramchangeset. 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 theEdit: Dropped now that we're targeting the@mermaid-js/mermaid-local-editorchangeset, since it's a private package.release/11.15.0branch that doesn't include this PR.feat: add XYZ feature to flowcharts, I've standardized them tofeat(flowchart): add XYZ feature to flowcharts. This also means that we are always mentioning which diagram types are affected by a fix/feature.📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.