Remove elkjs dependency from mermaid package
#5654
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The ELK integration was moved to it's own package in #5049 to avoid pulling in a copyleft dependency by default. However the `elkjs` dependency is still present in the mermaid package, this patch removes it.
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #5654 +/- ##
=======================================
Coverage 5.85% 5.85%
=======================================
Files 274 273 -1
Lines 41112 41101 -11
Branches 488 512 +24
=======================================
Hits 2408 2408
+ Misses 38704 38693 -11
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
|
@Gusted, Thank you for the contribution! |
DennisRasey
pushed a commit
to DennisRasey/forgejo
that referenced
this pull request
Jul 25, 2024
- `elkjs` is a library that's imported by `mermaid`, although they have seperated this package to it's own mermaid package (mermaid-js/mermaid#5654), the stable version doesn't have this patch. - `elkjs` is licensed under the EPL-2.0 license (copyleft), which isn't compatible with GPL unless the license author explcitly allow this via a so called "secondary license". At the end of the day it cannot be released under a MIT or GPL license. - Use webpack's `externals` option to avoid bundling `elkjs` and instead leave it as a `require` code. - This is a 'dirty' way to ensure elkjs isn't bundled and has to be tested manually to ensure this for every release (via the `webpack-bundle-analyzer` plugin). If someone tries to use the elkjs render, it will result in a non-descriptive error being shown. (cherry picked from commit 510cbe2)
DennisRasey
pushed a commit
to DennisRasey/forgejo
that referenced
this pull request
Jul 25, 2024
- `elkjs` is a library that's imported by `mermaid`, although they have seperated this package to it's own mermaid package (mermaid-js/mermaid#5654), the stable version doesn't have this patch. - `elkjs` is licensed under the EPL-2.0 license (copyleft), which isn't compatible with GPL unless the license author explcitly allow this via a so called "secondary license". At the end of the day it cannot be released under a MIT or GPL license. - Use webpack's `externals` option to avoid bundling `elkjs` and instead leave it as a `require` code. - This is a 'dirty' way to ensure elkjs isn't bundled and has to be tested manually to ensure this for every release (via the `webpack-bundle-analyzer` plugin). If someone tries to use the elkjs render, it will result in a non-descriptive error being shown. (cherry picked from commit 510cbe2)
DennisRasey
pushed a commit
to DennisRasey/forgejo
that referenced
this pull request
Jul 25, 2024
- `elkjs` is a library that's imported by `mermaid`, although they have seperated this package to it's own mermaid package (mermaid-js/mermaid#5654), the stable version doesn't have this patch. - `elkjs` is licensed under the EPL-2.0 license (copyleft), which isn't compatible with GPL unless the license author explcitly allow this via a so called "secondary license". At the end of the day it cannot be released under a MIT or GPL license. - Use webpack's `externals` option to avoid bundling `elkjs` and instead leave it as a `require` code. - This is a 'dirty' way to ensure elkjs isn't bundled and has to be tested manually to ensure this for every release (via the `webpack-bundle-analyzer` plugin). If someone tries to use the elkjs render, it will result in a non-descriptive error being shown.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
The ELK integration was moved to it's own package in #5049 to avoid pulling in a copyleft dependency by default. However the
elkjsdependency is still present in the mermaid package, this patch removes it.Resolves #5043 (comment)
📏 Design Decisions
N/A
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.developbranch