Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Remove public APIs for icons #5789

Merged
merged 8 commits into from
Aug 29, 2024
Merged

chore: Remove public APIs for icons #5789

merged 8 commits into from
Aug 29, 2024

Conversation

sidharthv96
Copy link
Member

@sidharthv96 sidharthv96 commented Aug 28, 2024

📑 Summary

We are planning to release an icons library separately.

Till we figure out the APIs for those, all external surface for icons are removed, to avoid making a breaking change when the new library comes.

The aws icons bundle also increased mermaid.min.js size by 50%, which is a problem for many libraries that ship mermaid without lazy loading.

image

📏 Design Decisions

Current plan is to create a library (or add support into mermaid), to consume iconify icons, so that users can integrate icons easily without having to create custom iconspacks for mermaid.

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

We are planning to release an icons library separately. Till we figure out the APIs for those, all external surface for icons are removed, to avoid making a breaking change when the new library comes.
Copy link

changeset-bot bot commented Aug 28, 2024

🦋 Changeset detected

Latest commit: eaae85c

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

This PR includes changesets to release 1 package
Name Type
mermaid 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

Copy link

netlify bot commented Aug 28, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit eaae85c
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/66d033842b26940008b26efc
😎 Deploy Preview https://deploy-preview-5789--mermaid-js.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 site configuration.

Copy link

argos-ci bot commented Aug 28, 2024

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

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Aug 29, 2024, 8:50 AM

Copy link

codecov bot commented Aug 28, 2024

Codecov Report

Attention: Patch coverage is 0% with 163 lines in your changes missing coverage. Please review.

Project coverage is 5.02%. Comparing base (4ac7c5e) to head (eaae85c).
Report is 9 commits behind head on develop.

Files with missing lines Patch % Lines
...mermaid/src/diagrams/architecture/icons/default.ts 0.00% 99 Missing ⚠️
...ermaid/src/diagrams/architecture/architectureDb.ts 0.00% 21 Missing ⚠️
...aid/src/diagrams/architecture/icons/svgRegister.ts 0.00% 12 Missing ⚠️
.../src/diagrams/architecture/architectureRenderer.ts 0.00% 11 Missing ⚠️
...kages/mermaid/src/diagrams/architecture/svgDraw.ts 0.00% 11 Missing ⚠️
packages/mermaid/src/mermaidAPI.ts 0.00% 9 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #5789      +/-   ##
==========================================
+ Coverage     4.67%   5.02%   +0.34%     
==========================================
  Files          348     336      -12     
  Lines        51597   48061    -3536     
  Branches       561     575      +14     
==========================================
  Hits          2413    2413              
+ Misses       49184   45648    -3536     
Flag Coverage Δ
unit 5.02% <0.00%> (+0.34%) ⬆️

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

Files with missing lines Coverage Δ
packages/mermaid/src/mermaid.ts 0.00% <ø> (ø)
packages/mermaid/src/mermaidAPI.ts 0.00% <0.00%> (ø)
.../src/diagrams/architecture/architectureRenderer.ts 0.00% <0.00%> (ø)
...kages/mermaid/src/diagrams/architecture/svgDraw.ts 0.00% <0.00%> (ø)
...aid/src/diagrams/architecture/icons/svgRegister.ts 0.00% <0.00%> (ø)
...ermaid/src/diagrams/architecture/architectureDb.ts 0.00% <0.00%> (ø)
...mermaid/src/diagrams/architecture/icons/default.ts 0.00% <0.00%> (ø)

... and 1 file with indirect coverage changes

@sidharthv96 sidharthv96 merged commit d279f4e into develop Aug 29, 2024
22 checks passed
@sidharthv96 sidharthv96 deleted the sidv/architecture branch August 29, 2024 09:26
@github-actions github-actions bot mentioned this pull request Sep 2, 2024
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