Grafi Git in Confluence

Un grafo Git mostra commit, rami e merge, così il team concorda su come il codice arriva a un rilascio.

Ultimo aggiornamento

Quando usarlo

Usa un grafo Git per spiegare una strategia di branching in una guida per chi contribuisce: rami di funzionalità, rami di rilascio, hotfix, backport. Scrivi i comandi in ordine (commit, branch, checkout, merge) e il diagramma disegna la storia che producono.

Esempio

Questo è il codice del modello Feature branch: un ramo unito a main prima di un rilascio.

gitGraph
  commit id: "Initial"
  commit id: "Set up CI"
  branch feature/search
  checkout feature/search
  commit id: "Add search API"
  commit id: "Add search UI"
  checkout main
  commit id: "Fix typo"
  merge feature/search id: "Merge search"
  commit id: "Release 1.2"

Vellnar Diagrams lo disegna così:

Cambia una riga e il diagramma cambia con lei. A nessuno serve il file originale del disegno, perché non esiste: il codice è il diagramma.

Aggiungerlo a una pagina di Confluence

  1. Modifica una pagina di Confluence e scrivi /mermaid dove vuoi il diagramma.
  2. Seleziona Mermaid diagram. Si apre l’editor con l’elenco dei modelli.
  3. Scegli un modello, oppure Start blank e incolla il codice qui sopra. L’anteprima segue ogni tasto.
  4. Scegli Save. Il diagramma compare nella pagina.

La documentazione spiega l’editor, le impostazioni e le esportazioni.

Modelli

Il pulsante Templates dell’editor ha 5 modelli pronti per questo tipo:

  • Feature branch: Un ramo unito a main prima di un rilascio.
  • Release branches: Develop, un ramo di rilascio e un merge con tag in main.
  • Hotfix: Una correzione partita da main e riportata in develop.
  • Trunk-based development: Rami di breve durata e rilasci quotidiani da main.
  • Backport: Una correzione fatta su main e riportata con cherry-pick su un ramo di rilascio.

Sintassi

Il codice inizia con gitGraph. La documentazione di Mermaid (in inglese) descrive ogni elemento della sintassi. Vellnar Diagrams lo disegna con Mermaid 12.3; se una riga ha un errore, l’editor segna la riga e tiene a schermo l’ultimo diagramma valido.

Altro

  • Mermaid in Confluence: come funzionano i diagrammi scritti come codice in una pagina, e tutti i tipi di diagramma.
  • Sicurezza: l’app non chiede nessun permesso e non manda nulla fuori da Atlassian.