-
Notifications
You must be signed in to change notification settings - Fork 2.2k
feat: Add support for custom (or offline) Mermaid.ink server and support all parameters #8799
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
Merged
Conversation
This file contains hidden or 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
Pull Request Test Coverage Report for Build 13115974036Details
💛 - Coveralls |
anakin87
approved these changes
Feb 3, 2025
@lbux just to let you know - your original PR is here |
Thanks! Good to know about the integration tests |
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.
this is a copy of a @lbux PR - #8772 - but this one is branched from our main repo instead of the user's fork which I suspect was the reason for the failure of some integrations tests - it keeps keeps the commit history, giving the correct credit to @lbux
Related Issues
Proposed Changes:
This PR is an attempt at adding support for offline pipeline draw() and show() calls for users in constrained environments where no requests to outside servers are allowed. This PR builds upon #8767 and introduces no breaking changes to regular draw() and show() calls (from what I've tested). Additionally, all parameters supported by Mermaid.ink are supported. The defaults remain as it was before (PNG image, neutral theme)
How did you test it?
Unit and integration tests were added testing different combinations of parameters. No tests were added to test a remote server since there is no way to properly test that in the CI. I tested it myself using my own docker hosted Mermaid server, but further testing would be needed. The original tests were not modified significantly to show the changes are most likely not breaking changes.
Notes for the reviewer
Several notes:
Checklist
fix:
,feat:
,build:
,chore:
,ci:
,docs:
,style:
,refactor:
,perf:
,test:
and added!
in case the PR includes breaking changes.