English README | 中文 README

📚 官方文档

🔍 项目描述 • 🍭 功能预览 • 🔧 部署安装 • 📌 待办清单 🚗 联系我们

项目描述 📚

一个利用大模型帮助我们在 Gitlab 上进行 Code Review 提升研发效能的项目 💪🏻 (( 包括但不限于 GPT 🎁))

这个项目有什么特点? ✨

🐶 针对于 Gitlab 定制

🐱 结合了GPT的能力 🚀

🦊 能够接入私有化 LLM 代码安全问题

🦁 我们将一直关注效能研发 最新的Coder Review动态 融入这个项目

项目架构 🚗

🚀 全新架构升级：更强大、更灵活、更高效！ 🌈

🌟 丰富的模型接入　支持轻松接入更多的模型，无论是经典模型还是最新的 AI 模型，都能轻松集成！

🔧 高度定制化　　　开发者可以便捷地自定义处理逻辑和回复机制，打造专属于你的解决方案！

🔗 扩展性强　　　　模块化设计使得功能扩展更加方便，未来可以轻松添加新功能，满足不断变化的需求！

🛠️ 高可维护性　　　代码结构清晰，注释详细，便于维护和二次开发，减少开发者的负担！

快来体验我们的新架构吧，享受前所未有的强大功能和极致体验！✨

功能预览 🌈

1. Gitlab Merge Request 触发评论

2. 钉钉消息通知

3. 更多种大模型接入

1. 可通过实现项目接口快速接入自定义模型，具体配置方式参见config.md。
2. 项目通过UnionLLM进行多模型支持， 兼容LiteLLM，默认支持模型如下表所示。

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
2. 可通过自定义更多的Review Handle引入自定义的代码审查逻辑，具体教程参见review.md

部署 📖

源代码运行 💻

1.克隆仓库

git clone [email protected]:mimo-x/Code-Review-GPT-Gitlab.git

2.安装依赖

pip install -r requirements.txt

3.修改配置文件

vim config/config.py

4.运行

python3 app.py

5.配置Gitlab webhook

填写Webhook URL时，请在域名后添加路径/git/webhook，例如：http://example.com/git/webhook

6.尝试发起一个 Merge Request 吧🎉

Docker

todo dockerfile

待办清单 📌

• ✅ 使用 GPT 进行Code Review
• ✅ 实现多模型支持
• 可以配置更多的触发方式
  • ✅ Merge Request
  • commit
  • tag
• 兼容飞书的消息通知
• 兼容钉钉的消息通知
• 结合静态代码分析来提供修改代码的风险等级
• 通过pydantic实现大模型输出内容的格式化

交流 👨‍👨‍👦‍👦

👏🏻 很高兴你能向我们提出一些问题和修改建议（issue，pr）, 欢迎 star 项目 ⭐️

📮 Email：[email protected]

📱 wx: isxuxin

👨‍👨‍👦‍👦 如果有任何使用问题，欢迎来这里交流 👋🏻

参考文献 📚

• (字节)基于大模型 + 知识库的 Code Review 实践
• (美团)代码变更风险可视化系统建设与实践

License 📑

This project is licensed under the MIT License.

Star History