GitLab CI visualisieren

So funktioniert es

1. 01

   .gitlab-ci.yml einfügen oder ablegen

   Die Pipeline-Datei aus dem Stammverzeichnis Ihres Projekts. YAML-Anker, extends-Vorlagen und !reference-Tags sind kein Problem, und ein spec-Header einer CI/CD-Komponente am Anfang wird übersprungen.

2. 02

   Pipeline in Spalten ansehen

   Stages werden zu Spalten von links nach rechts, jeder Job steht in der Spalte seiner Stage, und needs verbinden die Jobs, die vor ihrer Stage starten.

3. 03

   In Archboard öffnen

   Speichern Sie es als neues Diagramm, um Jobs umzuordnen, Notizen zu ergänzen, einen Link zu teilen oder als SVG und PNG zu exportieren. Für die Registrierung genügt ein Google- oder GitHub-Konto.

Was aus einer .gitlab-ci.yml gezeichnet wird

Das Diagramm folgt diesen Schlüsselwörtern in Ihrer Pipeline-Datei:

• stagesstage

  Stages als Spalten in der Reihenfolge Ihrer stages-Liste, ohne Liste build, test und deploy. Ein Job ohne Stage landet in test, und Stages ohne Jobs werden nicht gezeichnet.

• script

  Jeder Job als Karte in der Spalte seiner Stage. Schlüssel, die mit einem Punkt beginnen, sind Vorlagen: Sie werden nicht als Jobs gezeichnet, prägen aber weiterhin die Jobs, die von ihnen erben.

• needsneeds: []

  Eine Verbindung von jedem unter needs aufgeführten Job, sodass Jobs, die vor ihrer Stage starten, auffallen. needs: [] markiert einen Job, der sofort startet. Gestrichelt ist eine Verbindung, wenn der needs-Eintrag optional ist oder der wartende Job rules, only oder except hat.

• extends

  extends wird über bis zu 11 Vorlagenebenen aufgelöst, zusammen mit YAML-Ankern und Merge-Keys, sodass geerbte Werte für stage, needs, when, parallel, trigger und environment gezeichnet werden.

• parallelparallel:matrix

  parallel: 3 oder parallel:matrix lässt den Job eine einzige Karte bleiben, markiert mit ×3 oder der Zahl der Matrix-Kombinationen.

• trigger

  Trigger-Jobs, verbunden mit einer Karte für das, was sie starten: die Child-Pipeline-Datei aus trigger: include oder das Downstream-Projekt aus trigger: project.

• environment

  Jedes Environment, etwa review, staging oder production, als Karte, verbunden von den Jobs, die dorthin deployen.

• when: manual

  Manuelle Jobs mit der Markierung · manual, damit die Freigabeschritte Ihrer Pipeline auffallen.

Was ein GitLab-CI-Diagramm weglässt

• Konfiguration, die per include eingebunden wird, ob lokale Dateien, andere Projekte, entfernte URLs, Vorlagen oder CI/CD-Komponenten: Sie wird nicht geladen, und Jobs, die von einer Vorlage aus diesen Dateien erben, werden in den Warnungen aufgeführt.
• Ob rules, only oder except einen Job hinzufügen oder überspringen würden: Sie werden nicht ausgewertet, daher wird jeder Job gezeichnet.
• Variablen und ihre Werte, Skripte, Images, Caches und Artefaktpfade.
• Pipeline-Läufe: Job-Status, Laufzeiten, Logs und Artefakte. Das Diagramm zeigt die Konfiguration, nicht einen bestimmten Lauf.