DiagramPreview
進階預覽Live previewExportDeveloper tool

GitHub Actions 工作流圖

将 GitHub Actions YAML 中的 jobs、needs、steps 轉換为可读工作流圖。

範例
Detected YAML

This input may work better in the matching tool. Open YAML tool

預覽結果就緒
预览结果会显示在这里。

下一步可以繼續

把目前預覽結果帶到相關工具,繼續轉換、排查或匯出。

設計規範產生器

產生 Markdown 設計規範、檢查交接缺漏,並以流程圖補充說明。

開啟
AI 圖表生成器

用自然語言提示詞生成 Mermaid 圖表。

開啟
Mermaid AI 修復器

用 AI 修復 Mermaid 語法並提升圖表可讀性。

開啟

使用方法

  1. 1粘贴 GitHub Actions workflow YAML。
  2. 2检查触发器、job 依赖、matrix 和部署 gate。
  3. 3合并前 review permissions、secrets、pull_request_target 和 shell 命令。
  4. 4导出图用于 CI/CD 文档或发布 runbook。

常見場景

CI/CD workflow reviewGitHub Actions onboarding部署 gate 文档发布流水线图Workflow 安全 review

常見問題

合并 workflow YAML 前应该检查什么?

检查 permissions、触发器、secrets、部署环境、job 依赖,以及是否有下载远程代码的脚本。

为什么要可视化 GitHub Actions?

job 顺序和部署 gate 用图比长 YAML 更容易 review,尤其是 needs 和 matrix 较多时。

它能校验 workflow 吗?

不能。运行时校验仍靠 GitHub Actions,本工具用于预览、文档和 review。

GitHub Actions Workflow Diagram 会把 workflow YAML 中的 jobs、needs、触发器和关键步骤转成可读 CI/CD 图。

它帮助 reviewer 不用逐行扫描长 YAML,也能理解 build、test、deploy、release 的顺序。

图里也适合提示缺失 permissions、过宽触发器、secret 使用和危险 shell 安装模式。

Demo:review build-test-deploy 工作流

Workflow 图应该让依赖和部署 gate 一眼可见,也能帮助发现权限过宽或 secrets 过早暴露。

  • deploy job 应通过 needs 依赖 test job。
  • 在 workflow 或 job 层设置最小 permissions。
  • 生产部署使用 environments 做审批和保护。
name: CI
on: [push, pull_request]
permissions:
  contents: read
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm test
  deploy:
    needs: test
    environment: production
    runs-on: ubuntu-latest
    steps:
      - run: ./deploy.sh

调试方法:找出 CI 里的慢路径和风险路径

Workflow 图最有价值的地方是展示依赖、条件、环境和人工审批。这样能快速看出哪些 job 阻塞发布,哪些 job 权限过宽。

  • 沿着 needs 关系找到真正的关键路径。
  • 生产发布要把 branch、environment、approval 一起画出来。
  • 把 permissions 和 secrets 使用情况放在 job 图旁边 review。
jobs:
  test:
    runs-on: ubuntu-latest
  deploy:
    needs: test
    if: github.ref == 'refs/heads/main'
    environment: production

GitHub Actions 工作流圖 檢查清單

當你需要在文件、PR、事故復盤或交接材料發布前檢查原始內容時,可以使用 GitHub Actions 工作流圖。将 GitHub Actions YAML 中的 jobs、needs、steps 轉換为可读工作流圖。

匯出前建議檢查標籤是否可讀、關係是否和原始內容一致、範例是否包含敏感資訊,以及修改輸入後預覽是否仍然成立。

限制與排查

如果預覽失敗,先把輸入縮小到最小完整範例,確認格式語法,再逐段加回內容。

請把預覽結果視為 review 介面,而不是正式事實來源。進入文件或維運流程前仍需要人工確認。

可測試的範例輸入

  • Node CI: name: CI on: [push] jobs: test: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Install run: npm ci - name: Test run: npm test build: needs: test runs-on: ubuntu-...
  • Docker deploy: jobs: build: steps: - name: Build image run: docker build . deploy: needs: build steps: - name: Deploy run: kubectl apply -f k8s/
  • Matrix: jobs: test: strategy: matrix: node: [20, 22] steps: - run: npm test

工具完成度

進階預覽

進階解析

此工具會從開發者輸入中提取結構與關係,適合除錯與文件 review;複雜邊界仍建議回到原始碼確認。

分級不是品質分數,而是說明目前工具更適合穩定匯出、深度除錯、快速解析,或 AI 輔助生成。