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-CN.md