-
-
Notifications
You must be signed in to change notification settings - Fork 6.3k
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
feat | Vertical branches in Git Diagram #4639
feat | Vertical branches in Git Diagram #4639
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## develop #4639 +/- ##
============================================
+ Coverage 45.32% 77.13% +31.80%
============================================
Files 52 143 +91
Lines 6645 14535 +7890
Branches 18 516 +498
============================================
+ Hits 3012 11211 +8199
+ Misses 3633 3219 -414
- Partials 0 105 +105
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need tests covering this feature. Without them it would be very difficult to say if smth broke
Looks great!
|
Agree, I'll make the branch names turn 45 degrees. |
You could play around while placing labels. Ensure that they are not cut, may be some edge-cases in tests would cover that |
If the label is long it will cut no matter what. Can we have some threshold, that we guarantee, below which it won't cut? |
Not sure, there is no correct answer to that. Every diagram at some point will become unreadable. You simply cannot fit certain image in a very small boundaries. But for the majority of the cases I would simply took some real branches names for instance from that very project, or from any other one and would put them in a test case |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could be refactored a little bit to be more readable, but that is not the task. Great job. I am approving it. The only missing thing is the documentation. It would be great to add it with this PR, so as not to forget about it.
…github.com/mastersibin/mermaid into feature/4451-vertical-branches-in-gitgraph
I am merging this, but the code in its current state needs total refactoring, this is very difficult to understand what is happening there. Perhaps we need to redo the whole thing |
@mastersibin, Thank you for the contribution! |
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.2.4` -> `10.3.0`](https://renovatebot.com/diffs/npm/mermaid/10.2.4/10.3.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.2.4/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.2.4/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.3.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.3.0): 10.3.0 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.2.4...v10.3.0) #### What's Changed ##### Features - Sankey diagrams by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4502 - Feature/1838 actor creation destruction by [@​Valentine14th](https://togithub.com/Valentine14th) in [mermaid-js/mermaid#4466 - Vertical branches in Git Diagram by [@​mastersibin](https://togithub.com/mastersibin) in [mermaid-js/mermaid#4639 - Use JSON Schema to define and document `MermaidConfig` by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4112 - Remove the test checking whether the JSON Schema default config matched the old default config by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4610 - Fixes support of the macro `ContainerQueue_Ext` for C4 diagrams definition. by [@​kislerdm](https://togithub.com/kislerdm) in [mermaid-js/mermaid#4577 ##### Bugfixes - Make quadrant chart options TypeScript types optional by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4602 - Remove double parsing by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4587 - Fix flowchart tooltip typing bug by [@​lishid](https://togithub.com/lishid) in [mermaid-js/mermaid#4562 - Bug/4590 allow notes identical to keywords by [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) in [mermaid-js/mermaid#4597 - feat: allow specifying on which weekday a tickInterval should start by [@​leinelissen](https://togithub.com/leinelissen) in [mermaid-js/mermaid#4634 - Split formatted markdown strings with unicode support. by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4470 - fix: Mind maps handles `-` signs in node ids/text by [@​knsv](https://togithub.com/knsv) ##### Chores - Remove all TypeScript enums and forbid them in ESLint by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4580 - refactor accessibility by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4551 - chore: Reduce codecov pushes by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4604 - Run PR-labeler-config-validator only if config changes by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4607 - chore(deps): update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4624 - Update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4566 - Update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4581 - Rename workflow jobs by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4574 - Removed unused code in state diagrams by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4631 - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4623 - chore: remove unused `devDependency` on coveralls by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4641 - Allow entity diagram attribute names to start with asterisk by [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) in [mermaid-js/mermaid#4588 - Bug/4592 fix new line padding class diagram by [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) in [mermaid-js/mermaid#4633 - Fix graph not loading when the img loads too fast or fail to load by [@​pierrickouw](https://togithub.com/pierrickouw) in [mermaid-js/mermaid#4496 - convert `cypress/helpers/util.js` to ts by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4552 - build(deps-dev): bump word-wrap from 1.2.3 to 1.2.4 by [@​dependabot](https://togithub.com/dependabot) in [mermaid-js/mermaid#4652 - chore(deps): update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4663 - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4662 ##### Documentation - Sankey: Remove duplicated examples by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4595 - Release docs by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4493 - Update latest news section by [@​huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4495 - Fix Typo by [@​ryru](https://togithub.com/ryru) in [mermaid-js/mermaid#4567 - Docs: add ChatGPT plugin blog post by [@​huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4570 - Fix relative link to theme variables list by [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) in [mermaid-js/mermaid#4573 - Fix docs:dev by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4598 - Docs: update link - "Join the Community" by [@​huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4601 - Support docs:dev in docker by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4599 - docs(flowchart): add documentation on multiple nodes style by [@​tomperr](https://togithub.com/tomperr) in [mermaid-js/mermaid#4600 - Avoid downloading avtars everytime on docs:dev by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4603 - docs: Fix checkbox syntax by [@​guilhermgonzaga](https://togithub.com/guilhermgonzaga) in [mermaid-js/mermaid#4646 - Fix the "Edit this page on GitHub" link in Vitepress documentation for the Mermaid Config pages by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4640 - Support MERMAID_RELEASE_VERSION in docs. by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4612 - Docs: update Latest News section by [@​huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4655 - added Typora to integrations list by [@​kgilbert78](https://togithub.com/kgilbert78) in [mermaid-js/mermaid#4666 - Docs: Corrects name of C4 link by [@​Incognito](https://togithub.com/Incognito) in [mermaid-js/mermaid#4660 - Fix a typo by [@​gjtorikian](https://togithub.com/gjtorikian) in [mermaid-js/mermaid#4396 #### New Contributors - [@​ryru](https://togithub.com/ryru) made their first contribution in [mermaid-js/mermaid#4567 - [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) made their first contribution in [mermaid-js/mermaid#4573 - [@​kislerdm](https://togithub.com/kislerdm) made their first contribution in [mermaid-js/mermaid#4577 - [@​leinelissen](https://togithub.com/leinelissen) made their first contribution in [mermaid-js/mermaid#4634 - [@​pierrickouw](https://togithub.com/pierrickouw) made their first contribution in [mermaid-js/mermaid#4496 - [@​mastersibin](https://togithub.com/mastersibin) made their first contribution in [mermaid-js/mermaid#4639 - [@​kgilbert78](https://togithub.com/kgilbert78) made their first contribution in [mermaid-js/mermaid#4666 - [@​Incognito](https://togithub.com/Incognito) made their first contribution in [mermaid-js/mermaid#4660 - [@​gjtorikian](https://togithub.com/gjtorikian) made their first contribution in [mermaid-js/mermaid#4396 **Full Changelog**: mermaid-js/mermaid@v10.2.4...v10.3.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/levaintech/contented). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMS4wIiwidXBkYXRlZEluVmVyIjoiMzYuMTEuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@yogeshg I think this is because of GitHub. You can check if it is working on mermaid.live |
Oh gotcha. Thanks for the information. Since what version is this present in? Also, Do you know where I can request GitHub to update that version? |
A new feature that helps create Vertical branches for GitDiagram.
Resolves #2585
Issue #4451 closed as a duplicate, please refer to #2585
Discussed #3772