Upgrade Mermaid to 9.0.0
Problem to solve
As part of &7705 for devopscreate groupsource code we are discussing creating new content to explain the various merge strategies available to our users. The gitGraph
diagram type came out of experimental
status in https://github.com/mermaid-js/mermaid/releases/tag/9.0.0, which was released 2022-04-07. (Eight days ago! FINALLY!)
This graph type has been thoroughly revamped, and the documentation for it updated into a usable state: https://mermaid-js.github.io/mermaid/#/gitgraph Here's an example of how far you can take a gitGraph
:
This graph type would be IMMENSELY useful in our Git documentation, and would allow me to build the complex Git history graphs required to render the differences in merge strategies Mike Nichols described in &7705 (comment 871768658). (It's the last image in that comment.)
Of strong interest to @tlinz for Source Code, and @phikai for Code Review.
Proposal
- Upgrade Mermaid. How? I don't know.
package.json
in the root directory says"mermaid": "^8.13.10",
but I'm not sure if we'd need to do anything else? - We'd need to test to ensure existing diagrams are fine. We've got at least one really complex one in the docs (I'd have to dig to find the link) that should be checked locally before upgrading.
Who can address the issue
@sarahgerman? Some other kind engineer who will tell me what needs doing?
Other links/references
- Related to https://github.com/mermaid-js/mermaid/pull/2877
- Related to https://github.com/mermaid-js/mermaid/releases
- Related to #239131 (closed) where I got a lead of how the upgrade might be done