gitlab-ai-review 3.0.0 → 3.0.1

package/README.md

@@ -183,42 +183,180 @@ const results = await sdk.reviewAndCommentOnLines({
 
 ## 在 GitLab CI/CD 中使用
 
-`.gitlab-ci.yml` 示例：
+### 推荐配置：使用 npx 直接运行
+
+在 GitLab 项目根目录创建 `.gitlab-ci.yml` 文件：
 
 ```yaml
+# GitLab CI/CD 配置
+# 使用 gitlab-ai-review CLI (npx 方式)
+
 stages:
   - review
 
-ai-review:
+# gitlab-ai-review CLI 执行任务（推荐）
+ai-code-review:
   stage: review
-  image: node:18
+  image: node:18-alpine 
+  tags:
+    - docker   
+  timeout: 30m
   only:
-    - merge_requests
+    - merge_requests  # 只在 MR 时运行
+  variables:
+    # 🔑 手动传递 GitLab Token
+    # 注意：在生产环境中，应该在 GitLab CI/CD Settings > Variables 中配置
+    GITLAB_TOKEN: $GITLAB_TOKEN
+    
+    # 🤖 ARK API Key（用于 AI Review）
+    ARK_API_KEY: $ARK_API_KEY
+    
+    # GitLab CI 自动提供的环境变量（无需配置）：
+    # - CI_JOB_TOKEN (自动生成的临时 Token)
+    # - CI_SERVER_URL (GitLab 地址)
+    # - CI_PROJECT_ID (项目 ID)
+    # - CI_MERGE_REQUEST_IID (MR 编号)
+    
   script:
-    - npm install gitlab-ai-review
-    - node review.js
+    - echo ""
+    - echo "🔑 环境变量检查..."
+    - echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+    - echo "ARK_API_KEY = ${ARK_API_KEY}"
+    - echo "GITLAB_TOKEN = ${GITLAB_TOKEN:0:10}..."
+    - echo "CI_JOB_TOKEN = ${CI_JOB_TOKEN:0:10}..."
+    - echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+    - echo ""
+    - echo "🚀 使用 npx 执行 gitlab-ai-review CLI..."
+    - echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+    - npx gitlab-ai-review
+    
+  allow_failure: true  # 不阻塞 MR 合并
+  timeout: 10m  # 超时时间
 ```
 
-`review.js` 示例：
+### 环境变量配置
+
+在 GitLab 项目的 **Settings > CI/CD > Variables** 中配置：
+
+| 变量名 | 说明 | 是否必需 |
+|-------|------|---------|
+| `ARK_API_KEY` | 火山引擎 ARK API 密钥 | ✅ 必需 |
+| `GITLAB_TOKEN` | GitLab 访问令牌 | ⚠️ 建议配置（可用 `CI_JOB_TOKEN` 替代） |
+
+### AI 模型信息
+
+本项目使用**火山引擎豆包大模型**进行代码审查：
+
+- **模型**: `doubao-seed-1-6-251015`
+- **申请地址**: [火山引擎 ARK 平台](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seed-1-6)
+
+**如何申请 ARK API Key：**
+1. 访问 [火山引擎 ARK 控制台](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seed-1-6)
+2. 注册/登录账号
+3. 创建 API Key
+4. 将 API Key 配置到 GitLab CI/CD Variables 中
+
+---
+
+## 🎯 影响分析示例
+
+### 场景 1：删除被使用的函数
 
 ```javascript
-import GitLabAIReview from 'gitlab-ai-review';
+// 变更：删除了 utils/api.js 中的 fetchData
+- export function fetchData(url) { ... }
 
-const sdk = new GitLabAIReview();
+// AI 审查结果：
+🤖 AI 代码审查
 
-// 获取 MR 信息
-const mr = await sdk.getMergeRequest();
-console.log('正在审查 MR:', mr.title);
+⚠️ 严重问题：函数 fetchData 已被删除
 
-// 获取代码变更
-const changes = await sdk.getMergeRequestChanges();
-console.log(`共有 ${changes.length} 个文件变更`);
+影响分析显示：
+- components/UserList.vue (第 45 行) 在使用此函数
+- pages/Dashboard.vue (第 78 行) 在使用此函数
+- services/data.js (第 12 行) 在使用此函数
 
-// 添加评论
-await sdk.addComment('🤖 AI 代码审查已完成！');
+共 3 个文件将无法正常工作，建议：
+1. 恢复此函数，或
+2. 提供替代方案并更新所有调用处
+```
+
+### 场景 2：文件内部冲突
+
+```javascript
+// 变更：删除了辅助函数
+- function calculateTotal(items) { ... }
+
+export function checkout() {
+  const total = calculateTotal(cart.items)  // 💥 这里会报错
+  // ...
+}
+
+// AI 审查结果：
+🤖 AI 代码审查
+
+🚨 严重错误：文件内部冲突
+
+函数 calculateTotal 在第 5 行被删除，但在第 12 行仍被调用。
+这将导致运行时错误：ReferenceError: calculateTotal is not defined
+
+必须修复：
+1. 恢复 calculateTotal 函数，或
+2. 修改第 12 行的调用逻辑
+```
+
+### 场景 3：函数签名变更
+
+```javascript
+// 变更：修改了函数参数
+- export function process(data) { ... }
++ export function process(data, options = {}) { ... }
+
+// AI 审查结果：
+🤖 AI 代码审查
+
+⚠️ 函数签名已改变，新增了 options 参数
+
+影响分析显示有 8 个文件在使用此函数，但都未传递新参数。
+虽然有默认值，但建议检查是否需要在关键场景中传递 options。
+
+受影响的文件：
+- components/Processor.vue
+- services/processor.js
+...
 ```
 
-## 版本
+## 版本历史
+
+### 3.0.0 - 全面影响分析 🆕
+
+**重大更新**：从简单的 diff 审查升级为全面的影响分析系统
+
+- ✨ 删除符号检测：自动检测被删除的函数/类/组件，并分析影响范围
+- ✨ 文件内部冲突检查：检测文件内部是否使用了被删除的符号
+- ✨ 完整文件上下文：AI 审查时提供完整文件内容，而非仅 diff
+- ✨ 跨文件依赖追踪：使用 GitLab Search API 搜索符号使用情况
+- ✨ 修改符号识别：识别被修改的函数签名，检查 API 兼容性
+- ⚡ 使用火山引擎豆包大模型 `doubao-seed-1-6-251015`
+
+### 2.4.0
+
+- ✅ 行级 AI 代码审查
+- ✅ 批量审查和评论
+- ✅ 基础影响分析
+
+### 2.3.0
+
+- ✅ 支持 `reviewguard.md` 配置文件
+- ✅ 项目特定审查规则
+
+### 2.0.0
+
+- ✅ CI/CD 自动配置
+- ✅ 手动配置支持
+- ✅ GitLab API 客户端封装
+
+### 1.0.0
 
-- 1.0.1 - 添加 GitLab 客户端封装和自动配置
-- 1.0.0 - 初始测试版本
+- ✅ 初始版本发布
+- ✅ 基础 GitLab 集成

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlab-ai-review",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "GitLab AI Review SDK with Impact Analysis - 支持影响分析、删除符号检测、文件内部冲突检查的智能代码审查工具",
   "main": "index.js",
   "type": "module",