本文へスキップ
CI/CD 可視化

GitHub Actions 可視化ツール

GitHub Actions のワークフロー YAML を貼ると、job どうしの依存関係(needs)を読み取り、Mermaid のフローチャートにします。job を四角、needs を矢印で描くので、どの job が並列で動き、どの job が前の完了を待つのかが一目で分かり、CI が遅い原因探しに役立ちます。needs に書いた job 名が存在しないときは、赤い破線で示して、タイポを実行前に見つけられます。出力は GitHub の README・Issue・PR にそのまま貼れる Mermaid の記法で、job 名と依存関係を入力して、needs 付きの YAML の雛形を作ることもできます。step・matrix・if 条件は、詳細の表示をオンにすると箱の中に出ます。処理はすべてブラウザの中で行われ、YAML は送信されません。

入力した YAML と表示のオプションは、このブラウザに自動で保存されます(サーバーには送りません)。次に開いたときも続きから使えます。

graph TD A[Start] --> B[Input YAML] B --> C[Visualize]

ワークフローのセキュリティを検査

上の YAML にある、よくあるセキュリティ・保守の問題を探します(固定されていない action・広いトークン権限・スクリプトインジェクション・pull_request_target など)。文字を読むだけで、実行も送信もしません。

    実行回数とコストの目安

    各ジョブの matrix(include・exclude も)を展開して実行回数を数え、課金される分の目安を出します。登録が必要な secrets と変数も一覧にします。上の YAML を読むだけです。

    ガイド

    使い方・特徴

    • 「Workflow YAML を入力」欄に GitHub Actions の YAML を貼り付けます。
    • 「可視化する」ボタンをクリックすると、右側に図が表示されます。
    • ジョブ間の依存関係(needs)が矢印(-->)として描画されます。
    • 「Mermaidコードをコピー」で、GitHub の Markdown などに貼り付け可能な Mermaid コードを取得できます。
    サンプル

    入力例と出力例

    基本的なジョブの依存関係

    入力例
    jobs:
      build:
        runs-on: ubuntu-latest
      test:
        needs: build
        runs-on: ubuntu-latest
      deploy:
        needs: test
        runs-on: ubuntu-latest
    出力例
    graph TD
      build
      test
      build --> test
      deploy
      test --> deploy
    FAQ

    よくある質問

    • このツールは何を可視化しますか?

      GitHub ActionsのワークフローYAMLを解析し、ジョブ間の依存関係(needs)をMermaid.jsのフローチャートとして描画します。どのジョブがどのジョブの完了を待つのか、並列に走るのはどれかを視覚的に把握でき、複雑なパイプラインの全体像をつかむのに役立ちます。
    • ワークフローを実際に実行したり構文を検証したりしますか?

      いいえ。実行や本格的なバリデーションは行わず、依存関係の構造を図にするだけです。実際の挙動はGitHub上での実行ログで確認してください。図は設計やレビュー、ドキュメント用の俯瞰図として使うのが目的です。
    • YAMLを貼り付けても外部に送信されませんか?

      解析と描画はすべてブラウザ内で完結し、貼り付けたワークフローYAMLが外部サーバーへ送信されることはありません。社内リポジトリのワークフローも安心して可視化できます。
    使いどころ

    主な活用シーン

    • `needs` のつながりと実行順を一目で確認する

      ワークフローの YAML を貼ると、job を四角、`needs` を矢印にした図になります。どの job が並列で動き、どの job が前の完了を待つのかが見えるので、CI が遅い原因(直列になっている job)を探しやすくなります。
    • `needs` の書き間違いを見つける

      `needs` に書いた job 名が存在しないと、その job は赤い破線で描かれます。`build` を `biuld` と書いたようなタイポが、Actions を実行する前にわかります。
    • README・設計書にワークフロー図を載せる

      出力は Mermaid の記法です。GitHub の README・Issue・PR にそのまま貼ると図として描画されます。YAML を直したら貼り直すだけで、図を最新に保てます。
    • 新しいワークフローの骨組みを作る

      job の名前・`runs-on`・依存関係を入力すると、`needs` つきの YAML の雛形も作れます。ビルド→テスト→デプロイのような流れを、先に図で確かめてから書き込めます。
    注意点

    注意事項・制限

    • 描くのは job どうしの `needs` だけです

      step の中身、`matrix`、`if` による条件、トリガー(`on`)、再利用ワークフロー(`uses`)の展開は図に出ません。実際の実行順は、これらの条件で変わることがあります。
    • ワークフローの正しさは検証しません

      YAML として読めて `jobs` があれば図にします。GitHub のスキーマに沿っているか、`runs-on` や `uses` の値が有効か、循環した `needs` がないか、などは確認しません。実際の検証は GitHub 上の実行や `actionlint` で行ってください。
    • 図の表示名は `name`、なければ job のIDです

      job に `name` があればそれが、なければ job ID が箱に表示されます。Mermaid の予約語や記号を含む ID は、図の中では別の内部名に置き換えて描かれますが、表示される文字は変わりません。
    • 生成される YAML は雛形です

      作れるのは、`push` で動き、各 job が `echo` を実行するだけの最小の YAML です。実際の step、`on` のトリガー、`secrets` などは自分で書き足してください。シークレットの値は YAML に書かず、貼り付けないでください(入力はブラウザ内で処理され、送信はされません)。
    概要

    このツールについて

    GitHub Actions パイプライン可視化ツールとは

    複雑化した CI/CD パイプライン(GitHub Actions の workflow.yml など)の構成をパースし、ジョブ間の依存関係(needs)や実行順序をフローチャートとして視覚化するツールです。

    開発・運用におけるメリット

    昨今の開発現場では、テスト、Lint、ビルド、デプロイなど複数のジョブが並列または直列に実行される複雑なパイプラインが一般的です。YAMLファイルの行数が増えると、「どのジョブがどのジョブの完了を待っているのか」をコードから直感的に読み解くのが困難になります。
    本ツールにYAMLを貼り付けるだけで、ジョブの依存関係がツリー状のMermaidグラフとして即座に描画されるため、ボトルネックの発見や設計ミスの防止に大きく貢献します。データはすべてブラウザ内で処理され、外部に送信されることはありません。

    見落としやすい依存関係を整理する

    GitHub Actionsでは、needs の指定漏れや過剰な直列化によって、意図しない順番でジョブが動いたり、CI全体の待ち時間が長くなったりします。可視化しておくと、テスト、ビルド、デプロイ、通知といった工程の流れをチーム全員が同じ図で確認できます。
    特にモノレポや複数環境へのデプロイを扱う場合、YAML上では分かりにくい分岐が増えます。ステージングだけで動くジョブ、本番デプロイ前に必ず完了すべきジョブ、失敗しても後続を止めないジョブを区別して見ることで、運用事故の予防につながります。

    リファクタリング時の使い方

    ワークフローを分割する前に現在の依存関係を図にしておくと、移行後に同じ実行順序が保たれているか比較しやすくなります。古いジョブ名が残っていないか、並列実行できるテストが直列になっていないか、キャッシュ生成ジョブが必要な処理より後ろに配置されていないかといった確認にも向いています。

    おすすめリソース

    このセクションにはアフィリエイトリンクが含まれる場合があります。リンク経由で購入すると、追加費用なしでDevToolKits.appが紹介料を受け取ることがあります。

    このツールの関連記事

    このツールの実装解説

    運営者のZenn記事 ↗

    作る過程で踏んだバグや設計の判断を、Zennに書いています。

    最新記事