Skip to content

docs: change mermaidAPI.setConfig() changeset - #8024

Merged
aloisklink merged 1 commit into
mermaid-js:masterfrom
aloisklink:docs/replace-minor-bump-with-patch-bump
Aug 4, 2026
Merged

aloisklink merged 1 commit into
mermaid-js:masterfrom
aloisklink:docs/replace-minor-bump-with-patch-bump

Conversation

@aloisklink

Copy link
Copy Markdown
Member

📑 Summary

Add some more information the the deprecation of mermaidAPI.setConfig() to explain why it's been deprecated, and to change the changeset level to just a patch change instead of a minor change.

📏 Design Decisions

Technically, under semver, deprecation are supposed to be minor version bumps, but considering that this function is currently broken and not doing anything, and has been broken for a while, I think we can make this a patch version instead.

📋 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:.

Technically, under semver, deprecations are supposed to be `minor`
version bumps, but considering that this function is currently broken
and not doing anything, and has been broken for a while, I think we can
make this a `patch` version instead.
@changeset-bot

changeset-bot Bot commented Aug 4, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 319b8d1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes changesets to release 1 package
Name Type
mermaid Patch

Click here to learn what changesets are, and how to add one.

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

@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 96c2be6f-fe39-42fc-817b-166864cfb548

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@aloisklink
aloisklink merged commit 95b1b9c into mermaid-js:master Aug 4, 2026
10 of 11 checks passed
@aloisklink
aloisklink deleted the docs/replace-minor-bump-with-patch-bump branch August 4, 2026 14:48
@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.30%. Comparing base (eba7287) to head (319b8d1).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #8024   +/-   ##
=======================================
  Coverage   64.30%   64.30%           
=======================================
  Files         670      670           
  Lines       75072    75072           
  Branches    11171    11171           
=======================================
  Hits        48273    48273           
  Misses      26799    26799           
Flag Coverage Δ
unit 64.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.

@argos-ci

argos-ci Bot commented Aug 4, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Aug 4, 2026, 3:02 PM

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.

1 participant