https://github.com/mimo-x/code-review-gpt-gitlab
🤖 GPT（ Deepseek and more ） Code Review for Gitlab （针对于 Gitlab 的 LLM 辅助 Code Review 工具）项目详细文档 👇🏻
https://github.com/mimo-x/code-review-gpt-gitlab
bot codeanalysis codereview gitlab gpt llm
Last synced: 8 days ago
JSON representation
🤖 GPT（ Deepseek and more ） Code Review for Gitlab （针对于 Gitlab 的 LLM 辅助 Code Review 工具）项目详细文档 👇🏻
- Host: GitHub
- URL: https://github.com/mimo-x/code-review-gpt-gitlab
- Owner: mimo-x
- License: mit
- Created: 2023-10-19T14:10:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-08T06:15:57.000Z (12 days ago)
- Last Synced: 2025-04-12T08:13:43.166Z (8 days ago)
- Topics: bot, codeanalysis, codereview, gitlab, gpt, llm
- Language: Python
- Homepage: https://tqz0rsrhsvf.feishu.cn/docx/FlgzdMrj0oYOg2xXY7EcrsZZnjb?from=from_copylink
- Size: 5.29 MB
- Stars: 584
- Watchers: 6
- Forks: 64
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
English README | 中文 README
📚 官方文档
🔍 项目描述 •
🍭 功能预览 •
🔧 部署安装 •
📌 待办清单
🚗 联系我们
Powered By Mobvista 汇量科技 - 技术团队
# 项目描述 📚
> 一个利用大模型帮助我们在 Gitlab 上进行 Code Review 提升研发效能的项目 💪🏻 (( 包括但不限于 GPT 、DeepSeek 等🎁))
**这个项目有什么特点? ✨**
🐶 针对于 ** Gitlab ** 定制 (计划支持 Github 、Gitlab 、Gitee 、Bitbucket 等)
🤖 我们正在开发 ** Multi-Agent ** 的插件，多个 ** Agent ** 协同工作，共同完成评审
🐱 结合了 ** 多种大模型对接 ** 的能力 🚀
🦊 能够接入私有化 LLM ** 代码安全问题 **
🦁 我们将一直关注效能研发 ** 最新的Coder Review动态 ** 融入这个项目
# 项目架构 🚗
### 前期架构
### 🚀 **全新架构升级：更强大、更灵活、更高效！** 🌈
🌟 **丰富的模型接入** 支持轻松接入更多的模型，无论是经典模型还是最新的 AI 模型，都能轻松集成！
🔧 **高度定制化** 开发者可以便捷地自定义处理逻辑和回复机制，打造专属于你的解决方案！
🔗 **扩展性强** 模块化设计使得功能扩展更加方便，未来可以轻松添加新功能，满足不断变化的需求！
🛠️ **高可维护性** 代码结构清晰，注释详细，便于维护和二次开发，减少开发者的负担！
**快来体验我们的新架构吧，享受前所未有的强大功能和极致体验！✨**
# 功能预览 🌈
### 1. Gitlab Merge Request 触发评论
### 2. 钉钉消息通知
### 3. 更多种大模型接入
1. 可通过实现项目接口快速接入自定义模型，具体配置方式参见[config.md](doc/config.md)。
2. 项目通过[UnionLLM](https://github.com/EvalsOne/UnionLLM/)进行多模型支持，
兼容[LiteLLM](https://docs.litellm.ai/docs)，默认支持模型如下表所示。
OpenAI 🔥
Azure
AWS - SageMaker
AWS - Bedrock
Google - Vertex_AI
Google - Palm
Google AI Studio - Gemini
Mistral AI API
Cloudflare AI Workers
Cohere
Anthropic
Empower
Huggingface
Replicate
Together_AI
OpenRouter
AI21
Baseten
Vllm
NLP_Cloud
Aleph Alpha
Petals
Ollama
Deepinfra
Perplexity-AI
Groq AI
DeepSeek
Anyscale
IBM - Watsonx.ai
Voyage AI
Xinference [Xorbits Inference]
FriendliAI
Galadriel
智谱AI
月之暗面 Moonshot
百度文心一言
阿里巴巴通义千问
MiniMax
讯飞星火
百川智能
昆仑天工
零一万物
阶跃星辰
字节豆包
深度求索 DeepSeek 🔥
More
### 4.自定义更多的通知方式和处理手段
1. 可通过实现自定义``Response``类添加如邮箱，私有机器人等多种通知方式，具体教程参见[response.md](doc/response.md)
2. 可通过自定义更多的``Review Handle``引入自定义的代码审查逻辑，具体教程参见[review.md](doc/review.md)
# 部署 📖
#### Docker 运行
```bash
git clone [email protected]:mimo-x/Code-Review-GPT-Gitlab.git
cd Code-Review-GPT-Gitlab
vim ./config/config.py
docker run -d --network bridge --add-host=host.docker.internal:host-gateway -v ./config:/workspace/config -p 8080:80 --name codereview xuxin1/llmcodereview:latest
```
#### 源代码运行 💻
1.**克隆仓库**
```bash
git clone [email protected]:mimo-x/Code-Review-GPT-Gitlab.git
```
2.**安装依赖**
```bash
pip install -r requirements.txt
```
3.**修改配置文件**
```bash
vim config/config.py
```
4.**运行**
```bash
python3 app.py
```
#### **配置Gitlab webhook**
> 填写```Webhook URL```时，请在域名后添加路径```/git/webhook```，例如：```http://example.com/git/webhook```
#### **尝试发起一个 Merge Request 吧🎉**
# 待办清单 📌
- ✅ 使用 GPT 进行Code Review
- ✅ 实现多模型支持
- [ ] 可以配置更多的触发方式
- ✅ Merge Request
- [ ] commit
- [ ] tag
- [ ] 兼容飞书的消息通知
- [ ] 兼容钉钉的消息通知
- [ ] 结合静态代码分析来提供修改代码的风险等级
- [ ] 通过pydantic实现大模型输出内容的格式化
- ✅ 支持插件式自定义 Review 的问题
# 交流 👨👨👦👦
👏🏻 很高兴你能向我们提出一些问题和修改建议（Issue，PR）, 欢迎 **star 项目 ⭐️**
📮 *Email*：**[email protected]**
📱 *wx*：**isxuxin**
👨👨👦👦 如果有任何使用问题，欢迎来这里交流（AI 研发效能领域） 👋
# 参考文献 📚
- [(字节)基于大模型 + 知识库的 Code Review 实践](https://mp.weixin.qq.com/s?__biz=Mzg2ODQ1OTExOA==&mid=2247504479&idx=1&sn=1ec09afbb5b5b9b2aaf151994be5fd27&chksm=cea9655ef9deec48b17cbab05ddd1ab04c86736d8b469eaac6f5a707ca110ce4186e8985ff41&mpshare=1&scene=1&srcid=1011C8l5RmCM2EL4Rpl3wdRy&sharer_shareinfo=96d0a83631aaa25db87709baa250085d&sharer_shareinfo_first=96d0a83631aaa25db87709baa250085d#rd)
- [(美团)代码变更风险可视化系统建设与实践](https://tech.meituan.com/2023/09/22/construction-and-practice-of-code-change-risk-visualization-system.html)
## Star History
[](https://star-history.com/#mimo-x/Code-Review-GPT-Gitlab&Date)
## Powered by [Mobvista - 汇量科技](https://www.mobvista.com)
> **本项目由 [Mobvista 汇量科技](https://www.mobvista.com) 的技术团队研发及发布。**
[**Mobvista 汇量科技**](https://www.mobvista.com) 是全球领先的开发者增长平台。我们为全球开发者和营销人员**提供完整的广告和分析工具套件**，包括用户**获取、变现、分析、创意自动化和智能媒体采买**等，能大幅提升广告营销ROI，有效帮助移动应用突破增长平台期。
> **This tool is developed by the engineering team at [**Mobvista**](https://www.mobvista.com).**
Mobvista is a leading mobile technology company that provides **a complete suite of advertising and analytics tools** for app developers and marketers seeking global growth. Offering a range of tailored solutions, such as **user acquisition, monetization, analytics, creative automation, and cross-channel media buying**, Mobvista enables mobile businesses to maximize their potential.
For more information, please visit our website: www.mobvista.com
# License 📑
**This project is licensed under the [MIT License](https://chat.openai.com/c/9be6b422-f10c-4379-b152-e756230d54f8#:~:text=%E7%9A%84%E5%AE%8C%E6%95%B4%E6%96%87%E6%9C%AC%EF%BC%9A-,MIT%20License,-%E4%BD%A0%E5%8F%AF%E4%BB%A5%E8%AE%BF%E9%97%AE).**