GitLab CI の可視化ツール

使い方

1. 01

   .gitlab-ci.yml を貼り付けるかドロップ

   プロジェクトのルートにあるパイプラインファイルです。YAML のアンカー、extends のテンプレート、!reference タグも問題なく、先頭にある CI/CD コンポーネントの spec ヘッダーは読み飛ばします。

2. 02

   パイプラインを列で確認

   ステージは左から右への列になり、各ジョブは自分のステージの列に並びます。ステージより先に始まるジョブは needs の接続線でつながります。

3. 03

   Archboard で開く

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

.gitlab-ci.yml から描かれるもの

図はパイプラインファイル内の次のキーワードに従って作られます。

• stagesstage

  stages リストの順にステージを列として描きます。リストがなければ build、test、deploy です。ステージのないジョブは test に入り、ジョブのないステージは描きません。

• script

  各ジョブを、そのステージの列にカードとして描きます。ドットで始まるキーはテンプレートで、ジョブとしては描きませんが、それを継承するジョブには反映されます。

• needsneeds: []

  needs に挙げた各ジョブから接続線を描くので、ステージより先に始まるジョブがひと目でわかります。needs: [] はすぐに始まるジョブを示します。optional の needs や、rules、only、except を持つジョブへの接続線は破線になります。

• extends

  extends は最大 11 階層のテンプレートまで、YAML のアンカーやマージキーとあわせて解決するため、継承された stage、needs、when、parallel、trigger、environment の値も描かれます。

• parallelparallel:matrix

  parallel: 3 や parallel:matrix のジョブは 1 枚のカードのままで、×3 またはマトリックスの組み合わせ数が付きます。

• trigger

  トリガージョブは、起動する対象のカードにつながります。trigger: include で指定した子パイプラインのファイル、または trigger: project のダウンストリームプロジェクトです。

• environment

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

• when: manual

  手動ジョブには · manual が付くので、パイプラインの承認ステップがひと目でわかります。

GitLab CI の図に含まれないもの

• include で取り込む設定。ローカルファイル、別プロジェクト、リモート URL、テンプレート、CI/CD コンポーネントのいずれも取得せず、それらのファイルのテンプレートを継承するジョブは警告に一覧表示されます。
• rules、only、except によってジョブが追加されるかスキップされるか。評価しないため、すべてのジョブを描きます。
• 変数とその値、スクリプト、イメージ、キャッシュ、アーティファクトのパス。
• パイプラインの実行。ジョブの状態、所要時間、ログ、アーティファクト。図が表すのは設定で、特定の実行ではありません。