GitHub Actions visualisieren

So funktioniert es

1. 01

   Workflow-Datei einfügen

   Jede YAML-Datei aus .github/workflows, etwa ci.yml oder deploy.yml. Um mehrere Workflows zu vergleichen, fügen Sie sie zusammen ein, getrennt durch eine Zeile mit ---.

2. 02

   Pipeline ansehen

   Eine Trigger-Karte startet den Ablauf, Jobs folgen von links nach rechts in der Reihenfolge, die needs vorgibt, und jeder Job ist mit den Environments verbunden, in die er deployt, und mit den Service-Containern, die er nutzt.

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 Workflow-Datei gezeichnet wird

Diese Workflow-Schlüssel bestimmen das Diagramm:

• on

  Eine Trigger-Karte pro Workflow, beschriftet mit den ersten beiden Ereignissen und der Zahl der übrigen, etwa push · pull_request +1, verbunden mit jedem Job, der zuerst startet. workflow_call und workflow_run erhalten eigene Karten.

• jobs

  Jeder Job als Karte mit seinem Namen oder seiner Job-ID, wenn der Name einen Ausdruck enthält. Steps werden gezählt statt gezeichnet, und Jobs mit if-Bedingung erhalten gestrichelte eingehende Linien.

• needs

  Eine Verbindung von jedem unter needs aufgeführten Job zu dem Job, der auf ihn wartet, sodass Sie die Reihenfolge eines Laufs ablesen können. Unbekannte Job-IDs und Zyklen erscheinen als Warnungen.

• strategy.matrix

  Ein Matrix-Job bleibt eine Karte, markiert mit der Zahl der Jobs, die er erzeugt, etwa ×6, gezählt so, wie GitHub sie aufklappt, mit angewendetem include und exclude. Eine Matrix aus einem Ausdruck zeigt ×?.

• environment

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

• services

  Service-Container als Karten an ihrem Job: Images von postgres, redis und mongo erhalten passende Datenbankkarten, jedes andere Image eine Container-Karte.

• uses

  Ein Job, der einen wiederverwendbaren Workflow nutzt, ist eine Karte mit seinem Namen oder dem Workflow-Pfad und wird wie jeder andere Job über needs verbunden.

Was ein Workflow-Diagramm weglässt

• Einzelne Steps, ihre run-Skripte und die Actions, die sie nutzen: Steps werden nur gezählt.
• Laufergebnisse: ob ein Lauf erfolgreich war oder fehlschlug, wie lange Jobs dauerten und ihre Logs. Das Diagramm zeigt den Workflow so, wie er geschrieben ist.
• Die Jobs in einem wiederverwendbaren Workflow, egal ob er im selben Repository liegt oder in einem anderen: Seine Datei wird nicht geladen, daher bleibt er eine Karte.
• Das Ergebnis von if-Bedingungen und Ausdrücken: Ein Job wird auch gezeichnet, wenn seine Bedingung ihn überspringen würde, und env, secrets und with-Eingaben werden nicht gelesen.