CI/CD 管線助手
語言: English | 繁體中文
引導 CI/CD 管線設計,遵循業界最佳實踐與 DORA 指標。
管線階段參考
BUILD ──► TEST ──► ANALYZE ──► DEPLOY ──► VERIFY
建置 測試 分析 部署 驗證
| 階段 | 用途 | 關鍵活動 |
|---|---|---|
| Build | 編譯與打包 | 安裝相依、編譯、產出成品 |
| Test | 品質驗證 | 單元、整合、端對端測試 |
| Analyze | 程式碼品質 | 程式碼檢查、安全掃描、覆蓋率 |
| Deploy | 發布到環境 | 預備環境 → 正式環境部署 |
| Verify | 部署後驗證 | 冒煙測試、健康檢查、監控 |
DORA 指標快速參考
| 指標 | 菁英 | 高 | 中 | 低 |
|---|---|---|---|---|
| 部署頻率 | 隨需(每日多次) | 每週至每月 | 每月至半年 | > 6 個月 |
| 變更前置時間 | < 1 小時 | 1 天至 1 週 | 1 至 6 個月 | > 6 個月 |
| MTTR | < 1 小時 | < 1 天 | 1 天至 1 週 | > 6 個月 |
| 變更失敗率 | 0–15% | 16–30% | 16–30% | > 30% |
最佳實踐檢查清單
- 快速失敗 — 先執行最快的檢查(lint → 單元 → 整合 → E2E)
- 快取相依 — 在執行之間快取
node_modules、.m2、pip cache - 平行作業 — 將測試套件分散到平行執行器
- 不可變成品 — 建置一次,將相同成品部署到所有環境
- 環境一致 — 保持預備環境與正式環境一致
- 密鑰管理 — 絕不寫死密鑰;使用 vault/環境變數
- 分支保護 — 要求 CI 通過才能合併
- 回滾策略 — 部署失敗時自動回滾
平台專屬提示
| 平台 | 快取 | 平行化 | 密鑰 | 備註 |
|---|---|---|---|---|
| GitHub Actions | actions/cache |
matrix 策略 |
secrets.* |
使用 reusable workflows |
| GitLab CI | cache: 關鍵字 |
parallel: 關鍵字 |
CI/CD Variables | 使用 include: 模組化 |
| Jenkins | Stash/unstash | parallel {} 區塊 |
Credentials plugin | 使用 shared libraries |
CI 作業編排模式
反覆出現的 CI 作業編排模式(UDS #126)。每條原則平台無關;對照欄顯示各平台的寫法。
觸發分離
將重型慢速套件(完整 E2E)以觸發條件與每次變更的輕量檢查分離,使 runner 成本隨風險而非每次 push 成長。
| 需求 | GitHub Actions | GitLab CI | Jenkins |
|---|---|---|---|
| 重型套件排程觸發 | on: schedule: |
rules: if $CI_PIPELINE_SOURCE == "schedule" |
cron 觸發 |
| 輕量檢查每次變更 | on: pull_request |
rules: if $CI_PIPELINE_SOURCE == "merge_request_event" |
SCM webhook |
⚠️ 反模式:每次 push 跑完整 E2E。
共享資源序列化
當多個作業觸及同一個有狀態共享資源(單一測試環境 / runner / 部署目標)時,序列化以防並發污染。
| 需求 | GitHub Actions | GitLab CI | Jenkins |
|---|---|---|---|
| 互斥 | concurrency: { group: … } |
resource_group: |
lock(resource: …) |
⚠️ 反模式:兩作業並行寫同一 DB/環境。
變更偵測閘控
當某範圍的 HEAD 自上次成功未變(或變更只觸及範圍外路徑)時,跳過 deploy/test 以節省 runner。明確定義「未變」(上次成功 SHA 或路徑過濾)。
| 需求 | GitHub Actions | GitLab CI | Jenkins |
|---|---|---|---|
| 範圍未變則跳過 | paths: / dorny/paths-filter |
rules: changes: / SHA 比對 |
changeset 條件 |
⚠️ 反模式:文件-only commit 跑完整部署。
諮詢 vs 閘控作業
明確宣告每個作業是 advisory(回報但不擋合併)或 gating(擋合併)。混淆會在雜訊上卡關、或漏掉該擋的。(安全閘門是 Block/Warn/Log 特例——見 pipeline-security-gates。)
| 需求 | GitHub Actions | GitLab CI | Jenkins |
|---|---|---|---|
| Advisory(不擋) | continue-on-error: true |
allow_failure: true |
catchError → unstable |
| Gating(擋合併) | required status check | 預設(無 allow_failure) |
hard fail |
⚠️ 反模式:把雜訊 lint 設硬閘,或把關鍵套件設 advisory。
排錯:npm ci EUSAGE
npm ci 需要 committed lockfile。若 package-lock.json 被 gitignore,CI 會以 EUSAGE 失敗。修法:commit lockfile,或 CI-only 安裝用 npm install --no-audit --no-fund --ignore-scripts(跳過 CI 不需要的 prepare/husky hook)。
使用方式
/ci-cd- 顯示完整管線指引/ci-cd github-actions- GitHub Actions 專屬提示/ci-cd --optimize- 管線優化建議/ci-cd build- 建置階段最佳實踐
下一步引導
/ci-cd 完成後,AI 助手應建議:
管線指引已提供。建議下一步:
- 執行
/deploy設定部署策略- 執行
/security檢查管線安全- 執行
/testing設計測試策略- 執行
/commit建立規範化提交