跳到主要内容

GitHub 集成

连接您的 GitHub 仓库以进行自动分析。

功能​

  • 自动索引 在推送到主分支时
  • Pull Request 分析 提供架构反馈
  • Webhook 通知 用于分析结果

设置​

步骤 1：连接 GitHub​

  1. 前往 ArchiCore
  2. 点击 添加项目 → GitHub 选项卡
  3. 点击 连接 GitHub
  4. 授权 ArchiCore 访问您的仓库

步骤 2：选择仓库​

  1. 搜索您的仓库
  2. 选择一个分支（通常是 main 或 master）
  3. 启用选项：
    • 推送时自动分析 - 每次推送时索引
    • 分析 Pull Requests - 在 PR 上评论

步骤 3：配置（可选）​

在您的仓库中创建 .archicore/config.json：

{
  "github": {
    "autoIndex": true,
    "analyzePRs": true,
    "branches": ["main", "develop"]
  }
}

Pull Request 分析​

启用后，ArchiCore 会在 PR 上评论：

  • 架构影响 - 受更改影响的文件
  • 复杂性变化 - 如果复杂性增加
  • 安全警报 - 新引入的漏洞
  • 最佳实践 - 改进建议

所需权限​

权限原因
读取代码分析您的代码
读取 PR分析 Pull Requests
写入 PR 评论发布结果
Webhooks接收推送通知

断开连接​

要断开 GitHub 连接：

  1. 前往 设置 → 已连接账户
  2. 点击 GitHub 旁边的 断开连接

故障排除​

"找不到仓库"​

  • 确保仓库不是私有的，或者
  • 重新授权 ArchiCore 访问私有仓库

"Webhook 未触发"​

  1. 前往 GitHub → 仓库 → 设置 → Webhooks
  2. 检查 ArchiCore webhook 状态
  3. 查找失败的交付记录