GitGraph support for multiple tags

[sjackson0109]

Proposal

Am trying to demonstrate practicing different diagrams to my coleagues for wiki via code repo, using markdown with mermaid support.

I stumbled across an issue trying to add multiple tags to a feature release.

Issue: CANNOT USE MULTIPLE TAGS

my code:

gitGraph
    commit id: "ZERO"
    branch develop
    commit id:"A"
    checkout main
    commit id:"ONE"
    checkout develop
    commit id:"B"
    checkout main
    merge develop id:"Release 1.0" type:HIGHLIGHT tag: "SAML v2.0" tag: "OpenID v1.1"
    commit id:"TWO"
    checkout develop
    commit id:"C"

As you can see before adding the string `tag: "OpenID v1.1" to line 10 above, the diagram rendered perfectly.. except for the second ta...

Error:

Error: Parse error on line 10: ...HT tag: "SAML v2.0" tag: "OpenID v1.1" -----------------------^ Expecting 'EOF', 'NL', ';', got 'COMMIT_TAG'

It would be amazing to use multiple tags, stacked vertically!

(note: GitHub, GitLab and Azure DevOps all support multiple tags)

Example

No response

Screenshots

No response

[sjackson0109]

Tried all this with no luck:

• Comma-separated list, encapsulated in quotes
• Comma-separated list, without quotes
• Brace separated array
• multiple tag statements

[mtilda]

I would very much like this feature! I don't have capacity to work on this right now, but I can see where I would start...

This function creates the commit object, which could be refactored to accept multiple tags:

mermaid/packages/mermaid/src/diagrams/git/gitGraphAst.js

Line 112 in 549483d

export const commit = function (msg, id, type, tag) {

This code renders tags, which could be refactored to render multiple tags or support new-line characters in tag names:

mermaid/packages/mermaid/src/diagrams/git/gitGraphRenderer.js

Line 253 in 549483d

if (commit.tag) {

---

I can see how it would get tricky to render a multiline tag, as it might cause visual problems. I think supporting multiple tags is the way to go here.

---

Another consideration: if there are multiple tags on a commit, should the vertical distance between branches change to avoid overlapping?

[NicolasCwy]

Hi @sidharthv96 wanted to check since you tagged this as fosshack, does this mean this issue is open to PRs?

Edit: Will be giving this a shot!

[NicolasCwy]

@sidharthv96 From what I understand, I would have to amend the gitGraph.jison file to support multiple tag to be parsed is that correct? If you could link me to any guides on where I can learn this, the JISON repo seems quite dead and the linked BISON docs are dead too, I'm assuming this is based off BISON from GNU?

[sidharthv96]

I don't have any documentations, apart from the jison/bison repos. The grammar seems to be standard bison for most part.

We are actually migrating away from jison due to many issues.