GitHub Actions の可視化ツール

使い方

1. 01

   ワークフローファイルを貼り付け

   .github/workflows にある ci.yml や deploy.yml などの YAML ファイルなら何でも使えます。複数のワークフローを比べるときは、間に --- の行を入れてまとめて貼り付けてください。

2. 02

   パイプラインを確認

   トリガーカードから流れが始まり、ジョブは needs が決める順に左から右へ並びます。各ジョブはデプロイ先の環境や使うサービスコンテナーとつながります。

3. 03

   Archboard で開く

   新しい図として保存すれば、ジョブの配置変更、メモの追加、リンクの共有、SVG・PNG へのエクスポートができます。登録は Google か GitHub のアカウントだけで済みます。

ワークフローファイルから描かれるもの

図は次のワークフローのキーから作られます。

• on

  ワークフローごとに 1 枚のトリガーカードを描き、最初の 2 つのイベントと残りの数（push · pull_request +1 など）を表示して、最初に始まる各ジョブにつなぎます。workflow_call と workflow_run はそれぞれ専用のカードになります。

• jobs

  各ジョブを名前付きのカードとして描きます。名前に式が含まれる場合はジョブ ID を使います。ステップは描かずに数だけを数え、if 条件のあるジョブへの線は破線になります。

• needs

  needs に挙げた各ジョブから、それを待つジョブへの接続線を描くので、実行がたどる順序を読み取れます。見つからないジョブ ID や循環は警告として表示されます。

• strategy.matrix

  マトリックスのジョブは、生成するジョブ数（×6 など）を付けた 1 枚のカードのままです。数は include と exclude を適用して GitHub と同じ方法で数えます。式から作られるマトリックスは ×? と表示されます。

• environment

  staging や production などのデプロイ環境をそれぞれのカードとして描き、そこへデプロイするジョブからつなぎます。

• services

  サービスコンテナーはジョブに付いたカードになります。postgres、redis、mongo のイメージは対応するデータベースのカードに、それ以外のイメージはコンテナーのカードになります。

• uses

  再利用可能なワークフローを使うジョブは、名前またはワークフローのパスを示す 1 枚のカードになり、ほかのジョブと同じように needs でつながります。

ワークフロー図に含まれないもの

• 個々のステップ、その run スクリプト、使っているアクション。ステップは数だけを数えます。
• 実行結果。実行が成功したか失敗したか、ジョブにかかった時間、ログ。図は書かれたとおりのワークフローを表します。
• 再利用可能なワークフローの中のジョブ。同じリポジトリにあっても別のリポジトリにあっても、ファイルは取得しないため 1 枚のカードのままです。
• if 条件や式の評価結果。条件によってスキップされるジョブも描かれ、env、secrets、with の入力は読み取りません。