Skip to content

About

AI-powered GitHub App for automated PR reviews, security checks, and actionable code feedback.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

AutoGuard AI Code Reviewer

License Python FastAPI DeepSeek

基于 DeepSeek AI 的 GitHub App,为 Pull Request 提供自动化、智能化的代码审查服务。采用异步架构设计,具备企业级安全防护机制。

核心亮点

特性 说明
异步架构 全链路 async/await,基于 httpx 异步 HTTP 客户端,高并发处理
安全防护 HMAC-SHA256 签名验证(防时序攻击)、JWT RS256 签名、Token 10分钟有效期
优雅降级 AI 服务异常时自动发布友好提示评论,不阻塞 PR 流程
模块化设计 清晰的六模块分层架构,职责分离,易于扩展和维护
零配置启动 环境变量自动校验,启动时智能提示缺失配置
可观测性 结构化日志输出,健康检查端点,支持部署平台监控

功能特性

  • 自动触发: PR 创建 (opened) 或更新 (synchronize) 时自动启动审查
  • 智能分析: DeepSeek 大模型深度分析代码变更
  • 多维检查: 涵盖逻辑错误、安全漏洞、代码风格、性能问题四大维度
  • 精准输出: Markdown 格式结构化输出,支持 LGTM 快捷响应
  • 错误友好: 服务异常时优雅降级,发布可读的错误提示

AI 审查检查项

审查引擎针对以下维度进行深度分析:

┌─────────────────────────────────────────────────────────────┐
│  🔍 逻辑错误/Bug                                             │
│     • 空指针引用、未处理异常                                  │
│     • 死循环、递归溢出                                        │
│     • 资源泄漏(文件/连接未关闭)                             │
├─────────────────────────────────────────────────────────────┤
│  🔐 安全漏洞                                                 │
│     • SQL 注入、命令注入                                      │
│     • 硬编码密钥/密码/Token                                   │
│     • XSS、CSRF 风险                                         │
│     • 不安全的反序列化                                        │
├─────────────────────────────────────────────────────────────┤
│  📝 代码风格                                                 │
│     • 命名规范性(变量/函数/类)                              │
│     • 过长函数/类(建议拆分)                                 │
│     • 重复代码(建议抽象)                                    │
├─────────────────────────────────────────────────────────────┤
│  ⚡ 性能问题                                                 │
│     • 不必要的循环嵌套                                        │
│     • 低效算法/数据结构选择                                   │
│     • N+1 查询问题                                           │
└─────────────────────────────────────────────────────────────┘

技术架构

┌──────────────────────────────────────────────────────────────────┐
│                        GitHub Platform                             │
│  ┌─────────────┐    ┌─────────────┐    ┌─────────────────────┐   │
│  │   PR Event  │───▶│   Webhook   │───▶│  Installation Token │   │
│  │ (opened/    │    │   Delivery  │    │     (JWT Auth)      │   │
│  │  synchronize)│   │             │    │                     │   │
│  └─────────────┘    └─────────────┘    └─────────────────────┘   │
└──────────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌──────────────────────────────────────────────────────────────────┐
│                     AutoGuard Service                             │
│                                                                    │
│  ┌─────────────────────────────────────────────────────────────┐ │
│  │                    webhook_handler.py                        │ │
│  │  ┌─────────────┐  ┌─────────────┐  ┌─────────────────────┐  │ │
│  │  │ HMAC-SHA256 │  │  Payload    │  │   Event Filtering   │  │ │
│  │  │ Signature   │  │  Parsing    │  │  (opened/synchronize)│ │ │
│  │  │ Verification│  │             │  │                     │  │ │
│  │  └─────────────┘  └─────────────┘  └─────────────────────┘  │ │
│  └─────────────────────────────────────────────────────────────┘ │
│                              │                                    │
│                              ▼                                    │
│  ┌─────────────────────────────────────────────────────────────┐ │
│  │                       router.py                              │ │
│  │         Webhook Orchestrator & Error Handler                 │ │
│  └─────────────────────────────────────────────────────────────┘ │
│                              │                                    │
│              ┌───────────────┴───────────────┐                    │
│              ▼                               ▼                    │
│  ┌───────────────────────┐     ┌───────────────────────┐        │
│  │    github_api.py      │     │    ai_reviewer.py     │        │
│  │  ┌─────────────────┐  │     │  ┌─────────────────┐  │        │
│  │  │ Get PR Diff     │  │     │  │ DeepSeek API    │  │        │
│  │  │ (async httpx)   │  │     │  │ (OpenAI SDK)    │  │        │
│  │  └─────────────────┘  │     │  └─────────────────┘  │        │
│  │  ┌─────────────────┐  │     │  ┌─────────────────┐  │        │
│  │  │ Create Comment  │──┼─────▶│  │ AI Analysis    │  │        │
│  │  │ (async httpx)   │  │     │  │ (temp=0.3)      │  │        │
│  │  └─────────────────┘  │     │  └─────────────────┘  │        │
│  └───────────────────────┘     └───────────────────────┘        │
│              │                               │                    │
│              ▼                               ▼                    │
│  ┌───────────────────────┐     ┌───────────────────────┐        │
│  │    github_auth.py     │     │      config.py        │        │
│  │  ┌─────────────────┐  │     │  ┌─────────────────┐  │        │
│  │  │ JWT Generation  │  │     │  │ Pydantic        │  │        │
│  │  │ (RS256, 10min)  │  │     │  │ Settings        │  │        │
│  │  └─────────────────┘  │     │  └─────────────────┘  │        │
│  │  ┌─────────────────┐  │     │  ┌─────────────────┐  │        │
│  │  │ Installation    │  │     │  │ lru_cache       │  │        │
│  │  │ Token Fetch     │  │     │  │ Singleton       │  │        │
│  │  └─────────────────┘  │     │  └─────────────────┘  │        │
│  └───────────────────────┘     └───────────────────────┘        │
└──────────────────────────────────────────────────────────────────┘

技术栈

层级 技术选型 版本要求
Web 框架 FastAPI ≥0.109.0
ASGI 服务器 Uvicorn ≥0.27.0
HTTP 客户端 httpx (async) ≥0.26.0
AI SDK OpenAI (兼容 DeepSeek) ≥1.12.0
JWT 处理 PyJWT + cryptography ≥2.8.0 / ≥42.0.0
配置管理 pydantic-settings ≥2.0.0
环境变量 python-dotenv ≥1.0.0

快速开始

1. 克隆项目并安装依赖

git clone <your-repo-url>
cd AutoGuard-AI-Reviewer

python -m venv venv
source venv/bin/activate  # Linux/Mac
# 或 venv\Scripts\activate  # Windows

pip install -r requirements.txt

2. 配置环境变量

cp .env.example .env

必填配置:

GITHUB_APP_ID=<your_app_id>
GITHUB_PRIVATE_KEY=<your_pem_key>
WEBHOOK_SECRET=<your_secret>
DEEPSEEK_API_KEY=<your_api_key>

可选配置:

DEEPSEEK_BASE_URL=https://api.deepseek.com/v1  # API 地址
DEEPSEEK_MODEL=deepseek-chat                     # 模型选择
DEBUG=false                                      # 启用 API 文档
HOST=0.0.0.0                                     # 服务主机
PORT=8000                                        # 服务端口

3. 运行服务

python main.py

启动日志示例:

============================================================
🚀 启动 AutoGuard AI Code Reviewer
============================================================
✅ 所有必要的环境变量已配置
📍 Webhook 接收地址: POST /api/webhook
💚 健康检查地址: GET /health
============================================================

GitHub App 配置

权限配置

权限类型 权限名称 级别
Repository Pull requests Read & write
Repository Contents Read
Events Pull request Subscribe

私钥配置

私钥需完整保留换行符,或使用 \n 转义:

# 方式一:直接粘贴(保留换行)
GITHUB_PRIVATE_KEY=-----BEGIN RSA PRIVATE KEY-----
MIIE...
...
-----END RSA PRIVATE KEY-----

# 方式二:转义格式
GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nMIIE...\n-----END RSA PRIVATE KEY-----"

安全机制

Webhook 签名验证

采用 HMAC-SHA256 算法验证请求来源,防止伪造请求:

# 使用 constant_time_compare 防止时序攻击
hmac.compare_digest(expected_signature, signature)

JWT 认证

  • 算法:RS256(RSA 签名)
  • 有效期:10 分钟自动过期
  • 用途:换取 Installation Access Token

Token 管理

Installation Token 用于 API 调用,自动获取,无需手动管理。

高级配置

自定义审查 Prompt

修改 app/ai_reviewer.py 中的 REVIEW_PROMPT_TEMPLATE 可自定义审查规则:

REVIEW_PROMPT_TEMPLATE = """你是一个严苛但友好的高级工程师...
# 可在此添加自定义检查项
"""

切换 AI 模型

支持任何兼容 OpenAI SDK 的模型:

DEEPSEEK_BASE_URL=https://api.openai.com/v1
DEEPSEEK_MODEL=gpt-4

调整 AI 参数

在 ai_reviewer.py 中修改:

参数 当前值 说明
temperature 0.3 输出稳定性
max_tokens 4000 输出长度限制

API 端点

端点 方法 认证 说明
/ GET 无 服务信息
/health GET 无 健康检查
/api/webhook POST HMAC签名 Webhook 接收
/docs GET 无 Swagger 文档 (DEBUG)
/redoc GET 无 ReDoc 文档 (DEBUG)

部署

云平台部署(推荐)

支持 Zeabur、Heroku、Railway 等平台,自动识别 Procfile:

# 1. 连接 GitHub 仓库
# 2. 配置环境变量
# 3. 自动部署

自有服务器部署

systemd 服务配置:

[Unit]
Description=AutoGuard AI Code Reviewer
After=network.target

[Service]
Type=simple
User=autoguard
WorkingDirectory=/opt/autoguard
Environment="PATH=/opt/autoguard/venv/bin"
ExecStart=/opt/autoguard/venv/bin/uvicorn main:app --host 0.0.0.0 --port 8000
Restart=always

[Install]
WantedBy=multi-user.target

Docker 部署:

FROM python:3.11-slim

WORKDIR /app
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

COPY . .
EXPOSE 8000

CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]
docker build -t autoguard .
docker run -d -p 8000:8000 --env-file .env autoguard

本地测试

Webhook 测试

python test_webhook.py

ngrok 真实测试

python main.py
ngrok http 8000
# 将 ngrok URL 配置到 GitHub App Webhook

故障排查

问题 可能原因 解决方案
401 Unauthorized 签名验证失败 检查 WEBHOOK_SECRET 配置
500 AI Review Failed DeepSeek API 异常 检查 DEEPSEEK_API_KEY 和 API 状态
无评论发布 Installation Token 失败 检查 GITHUB_PRIVATE_KEY 格式
评论内容为空 PR diff 为空 空变更 PR 自动跳过

日志级别调整:

# main.py 中修改
logging.basicConfig(level=logging.DEBUG)  # 详细调试日志

项目结构

AutoGuard-AI-Reviewer/
├── app/
│   ├── config.py            # 配置管理 (Pydantic + lru_cache)
│   ├── github_auth.py       # JWT + Installation Token
│   ├── github_api.py        # GitHub REST API v3
│   ├── ai_reviewer.py       # DeepSeek/OpenAI SDK
│   ├── webhook_handler.py   # HMAC-SHA256 验证
│   └── router.py            # FastAPI 路由编排
├── main.py                  # 应用入口 + 生命周期管理
├── requirements.txt
├── .env.example
├── Procfile
├── test_webhook.py
└── README.md

Roadmap

  • 支持多语言审查 Prompt(英文/中文切换)
  • 行级评论(Inline Comments)支持
  • 审查结果缓存(避免重复审查相同 diff)
  • 支持 GitHub Checks API(更丰富的审查展示)
  • 自定义审查规则配置文件

贡献指南

  1. Fork 本仓库
  2. 创建特性分支:git checkout -b feature/your-feature
  3. 提交更改:git commit -m 'Add some feature'
  4. 推送分支:git push origin feature/your-feature
  5. 创建 Pull Request

License

MIT License


Powered by DeepSeek AI

About

AI-powered GitHub App for automated PR reviews, security checks, and actionable code feedback.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages