GitHub 工作流整合指南
引導您如何將 GIIP 平台與 GitHub 倉庫連接,從而監控原始碼變更並將其與基礎設施任務整合。
📋 概述
通過 GitHub 工作流整合,系統管理員和開發人員可以輕鬆識別基礎設施的變化是由哪些代碼變更引起的。通過在 GIIP 內直接查看 GitHub 的提交歷史和 Pull Request 狀態,可以最大限度地減少工作上下文切換。
🔍 核心功能
1. 倉庫 (Repository) 連接
- OAuth 認證: 關聯 GitHub 帳號以獲取可訪問的倉庫列表。
- 專案映射: 將特定 GitHub 倉庫與 GIIP 內的專案關聯,實現代碼與資產(伺服器等)的匹配。
2. 即時 Webhook 通知
- 事件收集: 當發生推送 (Push)、拉取請求 (Pull Request)、發佈 (Release) 等事件時,會自動記錄在 GIIP 的問題管理系統中。
- 問題自動更新: 在提交資訊中包含特定的 GIIP 問題編號(如
),該問題的狀態將自動更新。fix #123
3. CI/CD 與代碼質量整合
- 確認 Action 狀態: 在 GIIP 儀表板上即時確認 GitHub Actions 的建置和部署是否成功。
- 安全掃描結果: 將代碼內的安全漏洞掃描結果(如 Dependabot 等)共享給 GIIP 安全中心。
🛠️ 設置步驟
- 進入 GIIP [環境設置] > [GitHub 關聯] 菜單。
- 點擊 [Connect GitHub] 按鈕並授權。
- 選擇要關聯的倉庫並完成 [分配專案]。
- 如有需要,複製 Webhook URL 並將其添加到 GitHub 倉庫設置中。
💡 技巧
- 故障原因追蹤: 在伺服器負載驟增的時間點,立即在 GitHub 歷史選項卡中對比當時合併了哪些代碼。
- 加強協作: 對於需要變更基礎設施的 PR,將 GIIP 代理的作業結果連結留在 PR 評論中,以提高評審效率。
API 參考
有關此功能的 API 詳細規格,請參閱單獨的指南。
疑難排解
| 症狀 | 原因 | 解決 |
|---|---|---|
| 未顯示要關聯的倉庫列表 | GitHub OAuth 認證或權限授權未完成 | 點擊 [Connect GitHub] 按鈕重新授權。 |
| 提交後 GIIP 問題狀態未自動更新 | 提交資訊中未包含問題編號(如 ) | 在提交資訊中以正確格式包含問題編號後重新提交。 |
| Push/PR 事件未記錄到 GIIP | GitHub 倉庫中未註冊 Webhook URL | 複製設置頁面的 Webhook URL 並添加到 GitHub 倉庫設置中。 |
| 儀表板上不顯示 GitHub Actions 狀態 | 倉庫未分配到 GIIP 專案 | 選擇倉庫並完成 [分配專案]。 |
版本: 1.0 最後更新: 2026-03-19 源文件:
giipv3/public/help/github-workflow.zh-TW.md