跳至內容
CI/CD 可視化

GitHub Actions 可視化工具

貼上 GitHub Actions 的工作流程 YAML,就會讀取 job 之間的相依關係(needs),轉成 Mermaid 流程圖。job 是方框、needs 是箭頭,能一眼看出哪些 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 等)。只讀取文字,不會執行或傳送任何內容。

    執行次數與成本估算

    將每個 job 的 matrix(含 include / exclude)展開成執行次數,並估算計費分鐘數。也會列出需要登錄的 secrets 與變數。只讀取上方的 YAML。

    指南

    使用方式與特色

    • 將您的 GitHub Actions YAML 貼入「輸入工作流 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

    常見問題

    • 可以可視化大型工作流嗎?

      可以,但對於作業數量非常多(數十個或更多)的工作流,圖表可能會變得非常大且難以閱讀。在這種情況下,建議分段可視化工作流。
    • 支援除了「needs」以外的依賴關係嗎?

      目前該工具僅可視化由「needs」屬性定義的作業級依賴關係。作業內部的個別步驟(steps)不會被可視化。
    • 我的 YAML 資料安全嗎?

      絕對安全。所有運算都在您的瀏覽器本地完成,不會將資料傳送到伺服器,因此可用於私有或企業級的工作流配置。
    使用情境

    主要使用情境

    • 一眼看懂 `needs` 關係與執行順序

      貼上工作流程的 YAML,job 會變成方框、`needs` 會變成箭頭。能看出哪些 job 並行、哪些要等前一個完成,也就更容易找出 CI 變慢的原因(串聯執行的 job)。
    • 找出 `needs` 的拼字錯誤

      若 `needs` 中寫的 job 名稱不存在,該 job 會以紅色虛線繪製。像把 `build` 寫成 `biuld` 這類錯誤,在執行工作流程之前就能發現。
    • 在 README 與設計文件中放入工作流程圖

      輸出是 Mermaid 語法。貼到 GitHub 的 README、Issue 或 PR 就會繪製成圖。修改 YAML 後只要重新貼上,就能讓圖保持最新。
    • 規劃新的工作流程

      輸入 job 名稱、`runs-on` 與相依關係,即可產生含 `needs` 的 YAML 範本。可以先用圖確認 build → test → deploy 的流程,再實際撰寫。
    注意

    注意事項與限制

    • 只繪製 job 之間的 `needs`

      step 的內容、`matrix`、`if` 條件、觸發條件(`on`)以及可重用工作流程(`uses`)的展開都不會顯示在圖中。實際的執行順序可能因這些條件而改變。
    • 不會驗證工作流程是否正確

      只要能讀成 YAML 且含有 `jobs` 就會繪圖。不會檢查是否符合 GitHub 的結構、`runs-on` 或 `uses` 的值是否有效,也不會檢查 `needs` 是否循環。請以在 GitHub 上實際執行或 `actionlint` 驗證。
    • 顯示名稱為 `name`,沒有時為 job ID

      job 有 `name` 時方框顯示 `name`,否則顯示 job ID。含有 Mermaid 保留字或符號的 ID 會在圖中改用安全的內部名稱繪製,但顯示的文字不會改變。
    • 產生的 YAML 只是範本

      只會產生以 `push` 觸發、每個 job 只執行 `echo` 的最小 YAML。實際的 step、`on` 觸發條件與 `secrets` 請自行補上。請勿在 YAML 中寫入或貼上機密值(輸入僅在瀏覽器內處理,不會傳送)。
    簡介

    關於此工具

    GitHub Actions 視覺化工具

    視覺化 GitHub Actions workflow 的 jobs、dependencies 與 needs 關係。適合理解複雜 CI/CD pipeline,並找出瓶頸或錯誤依賴。

    常見用途

    • 檢查 CI/CD 流程:了解 job 執行順序。
    • 除錯依賴關係:確認 needs 是否符合預期。
    • 文件化 pipeline:用更清楚的視圖分享 workflow 結構。

    修改重要 workflow 時,也請檢查 permissions、secrets 與 triggers。

    這個工具的相關文章

    最新文章