dannysteenman/pr-agent

AI PR Agent Docker镜像文档

镜像概述

AI PR Agent Docker镜像是一款基于人工智能技术的Pull Request辅助工具，旨在自动化处理GitHub等代码托管平台的Pull Request（PR）流程。通过集成自然语言处理和代码分析能力，该镜像可实现PR描述自动生成、代码审查、交互式问答等功能，帮助开发团队减少人工操作成本，提升协作效率与代码质量。

核心功能和特性

核心功能

• PR描述自动生成：基于代码变更内容，自动生成结构化PR描述，包含变更目的、实现方案、测试情况等关键信息。
• 智能代码审查：分析代码变更中的潜在问题（如语法错误、性能隐患、安全漏洞），提供修改建议。
• 交互式问答：支持通过PR评论区提问，AI实时解答与变更相关的技术细节（如实现逻辑、API用法等）。
• 多平台兼容：适配GitHub、GitLab等主流代码托管平台，支持Webhook触发与API调用。

特性

• 轻量化部署：Docker容器化设计，支持快速启动与跨环境部署。
• 可配置规则：允许通过配置文件自定义审查规则、描述模板、问答策略。
• 隐私保护：本地部署模式下，代码与数据无需上传至第三方服务，保障信息安全。
• 低资源占用：优化模型加载与运行机制，支持CPU/GPU灵活切换。

使用场景和适用范围

适用场景

• 开源项目维护：帮助维护者快速处理大量社区PR，降低人工审核压力。
• 团队协作开发：规范PR提交格式，减少团队沟通成本（如重复解释变更内容）。
• 高频PR场景：适用于CI/CD流程中频繁触发PR的项目（如微服务迭代、前端组件库开发）。
• 新手开发者支持：为团队新人提供PR规范引导，辅助理解代码审查标准。

适用范围

• 个人开发者、中小型开发团队、大型企业研发部门。
• 基于Git的代码管理流程，且依赖PR进行代码合并的项目。
• 需平衡开发效率与代码质量的场景（如敏捷开发、快速迭代项目）。

使用方法和配置说明

环境要求

• Docker Engine 20.10+
• 网络连接（用于访问代码托管平台API及模型服务，本地模型需额外配置）
• （可选）GPU支持（如需加速模型推理）

基本部署命令

快速启动（GitHub示例）

bash
docker run -d \
  --name ai-pr-agent \
  -e PLATFORM=github \
  -e GITHUB_TOKEN=<your_github_pat> \  # 需包含repo权限的个人访问令牌
  -e MODEL_TYPE=local \  # 可选：local/cloud，local需挂载模型文件
  -v /path/to/local/model:/app/models \  # 本地模型路径（如使用local模式）
  -v /path/to/config:/app/config \  # 自定义配置文件路径
  ai-pr-agent:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  ai-pr-agent:
    image: ai-pr-agent:latest
    container_name: ai-pr-agent
    restart: unless-stopped
    environment:
      - PLATFORM=github
      - GITHUB_TOKEN=${GITHUB_TOKEN}  # 建议通过.env文件传入
      - MODEL_TYPE=cloud
      - OPENAI_API_KEY=${OPENAI_API_KEY}  # 如使用云模型（如GPT系列）
      - PR_REVIEW_LEVEL=medium  # 审查级别：low/medium/high（控制审查深度）
    volumes:
      - ./config:/app/config  # 存放自定义规则（如审查白名单、描述模板）
    ports:
      - "8080:8080"  # 暴露Webhook接收端口（如需主动触发）

核心配置参数

自定义配置文件

通过挂载/app/config目录，可添加以下自定义文件：

• review_rules.yaml：自定义审查规则（如忽略特定目录、强制检查项）
• description_template.md：PR描述模板（支持变量如{{CHANGE_SUMMARY}}、{{AUTHOR}}）
• qa_prompts.txt：问答场景提示词优化（如限定回答风格、技术术语偏好）

触发方式

• Webhook触发：在代码平台配置PR相关事件（如pull_request.opened）的Webhook，指向容器暴露的WEBHOOK_PORT。
• 手动触发：通过API调用http://<container-ip>:8080/trigger?pr_url=<pr-full-url>触发指定PR处理。

注意事项

• API密钥安全：避免将敏感令牌（如GitHub Token、模型API Key）直接写入命令或配置文件，建议通过环境变量或密钥管理工具传入。
• 模型性能：本地模型需确保宿主机硬件满足运行要求（如内存≥8GB、GPU显存≥4GB）。
• 规则更新：修改配置文件后需重启容器使规则生效。