Skip to content

richLpf/code-review

Repository files navigation

🚦 Code Review 项目

基于 AI 的自动化代码审查系统,支持 GitLab Merge Request 审查,可通过 Docker Compose 一键启动服务与数据库。


🚀 快速启动

✅ 支持 MySQL(推荐版本:8.0)与 MariaDB(推荐版本:10.5

环境依赖

  • docker && docker compose > 2.0
  • git

1️⃣ 克隆项目

git clone https://github.com/richLpf/code-review.git
cd code-review

2️⃣ 配置环境变量

假设服务器 IP 为:192.168.1.1

方式一:使用自有数据库

# 先在数据库中执行初始化 SQL 脚本
cd mysql/init

# 编辑环境变量
vi .env

# 服务启动
docker compose up -d

方式二:使用内置 MySQL

cp .env.mysql .env
vi .env  # 修改数据库密码等必要配置
docker compose -f docker-compose.mysql.yml up -d

方式三:使用内置 MariaDB

cp .env.mariadb .env
vi .env
docker compose -f docker-compose.mariadb.yml up -d

3️⃣ 访问控制台

在浏览器中访问:

🌐 地址:http://192.168.1.1:9003 🔐 默认账号密码:admin / 12345678

控制台示意图:

控制台

首次登录请配置以下内容:

  • ✅ AI 模型 Key(支持主流模型)
  • ✅ GitLab Token(需具备完整权限)
  • ✅ 企业微信机器人(可选)

📡 配置 Webhook(GitLab)

在对应项目中:

SettingsWebhooks

添加如下地址:

http://192.168.1.1:9000/v1/webhook/merge

✅ 如果 GitLab 支持 Group Webhook,推荐在 Group 层级统一配置。

勾选事件类型:Merge request events

提交 Merge Request 时将自动触发 AI 审查。

Webhook 配置示意:

Webhook配置

AI 检查示例:

Webhook触发


❓ 常见问题

问题 解决方案
镜像拉取失败 检查网络连接,或替换为国内镜像源
启动后无法访问 检查服务器防火墙,确保开放端口 90009003
无法连接数据库 数据库可能启动较慢,执行 docker compose restart 重试

📝 更新日志

  • ✅ 支持自定义 GitLab 地址
  • ✅ 支持多个 GitLab Token
  • ✅ 支持 webhook 推送 AI 检查结果
  • ✅ 提供快速部署方案
  • ✅ 集成 UCloud 模型,支持切换私有/公有大模型

🔭 规划中功能

  • 支持通过 projectId + mergeId 直接发起 AI 审查
  • 支持监听 GitLab Push 事件
  • 提供一键启动的 Docker 镜像(支持挂载配置)
  • 提供 .gitlab-ci.yml 示例实现 CI/CD 集成
  • 优化 GitLab Token 添加/更新流程,自动刷新模型缓存

About

an ai code review tool

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published