best-review 0.5.9 → 0.5.13

package/README.md

@@ -5,12 +5,12 @@
 这个项目的重点不是替代人工 Review，而是把可重复的风险检查前置到本地、CI 和 GitLab Merge Request 流程里：
 
 - 本地审查未提交变更、提交范围、指定文件或完整文件内容。
-- GitLab MR 远程审查，并把问题回评到 MR 行内 discussion。
+- GitLab MR 远程审查，可按配置把问题回评到 MR 行内 discussion。
 - 内置 `general`、`bug-hunter`、`security-scan`、`performance-check`、`consistency-check`、`validation` Agent。
 - 支持用户级规则、共享 `extends` 规则包和项目级 `skills/` 审查增强。
 - 默认执行置信度过滤、去重、validation 复核，减少泛泛建议和误报。
 - 支持显式自动修复严重风险，先生成 unified diff，并通过 `git apply --check` 后才写入。
-- 生成本地 JSON 报告；本地 `review` 配置历史仓库后会自动归档，`review-mr` 只回评 MR。
+- 生成本地 JSON 报告；GitLab 写操作默认关闭，需要通过配置开关显式开启。
 
 ## 快速开始
 
@@ -97,10 +97,12 @@ best-review review --fix-critical
 best-review review --fix-severity critical,high --fix-dry-run
 best-review review --fix-critical --fix-max-issues 3 --fix-patch-file ~/.best-review/fix.patch
 
-# GitLab MR 远程审查
-br init GITLAB_TOKEN
+# GitLab MR 远程审查（默认只读）
 best-review review-mr https://gitlab.example.com/group/project/-/merge_requests/123
 
+# 如需回评 MR discussion，先配置发布 token 并打开 gitlab.uploadEnabled
+br init GITLAB_TOKEN
+
 # 查看内置资产和执行器
 best-review agents
 best-review rules
@@ -161,7 +163,8 @@ POST <llm.baseUrl>/chat/completions
     "model": "deepseek-v4-flash"
   },
   "gitlab": {
-    "token": "<your-gitlab-token>"
+    "token": "<your-gitlab-token>",
+    "uploadEnabled": false
   },
   "executors": {
     "openai-compatible-api": {
@@ -197,7 +200,8 @@ POST <llm.baseUrl>/chat/completions
     "model": "deepseek-v4-flash"
   },
   "gitlab": {
-    "token": "<your-gitlab-token>"
+    "token": "<your-gitlab-token>",
+    "uploadEnabled": true
   },
   "executors": {
     "deepseek-api": {
@@ -367,28 +371,40 @@ best-review extends remove https://github.com/org/best-review-rules.git
 
 ## GitLab Merge Request
 
-`review-mr` 会直接读取 GitLab MR diff 和远程文件内容，运行同一套 pipeline，并默认启用 GitLab Reporting。
+`review-mr` 会直接读取 GitLab MR diff 和远程文件内容，运行同一套 pipeline。GitLab discussion 回评属于写操作，默认关闭，需要显式开启。
 
 ```bash
-br init GITLAB_TOKEN
-
 best-review review-mr https://gitlab.example.com/group/project/-/merge_requests/123
 best-review review-mr <mr-url> --agent security-scan --log-steps
 best-review review-mr <mr-url> --executor deepseek-api --model deepseek-v4-flash
+
+# 如需回评 MR discussion，再初始化发布 token
+br init GITLAB_TOKEN
 ```
 
-如果运行 `review-mr` 时当前环境和用户级配置都没有 `GITLAB_TOKEN`，CLI 会在交互式终端中提示填写并写入 `~/.best-review/config.json`；直接回车会取消本次 MR 审查。CI 中仍可通过 `export GITLAB_TOKEN=<token>` 或平台变量注入。
+如需把审查结果回评到 MR，先在用户级配置打开上传开关，并提供发布 discussion 的 `GITLAB_TOKEN`：
 
-`review-mr` 启动前会先校验内置 GitLab 配置是否存在：`BEST_REVIEW_HISTORY_REMOTE`、`BEST_REVIEW_HISTORY_BRANCH`、`GITLAB_HOST`、`BEST_REVIEW_HISTORY_USER_TOKEN`。其中 `BEST_REVIEW_HISTORY_USER_TOKEN` 只用于读取 MR 和解析 GitLab 用户；`GITLAB_TOKEN` 只用于向 MR 发布 discussion。
+```json
+{
+  "gitlab": {
+    "uploadEnabled": true,
+    "token": "<your-gitlab-token>"
+  }
+}
+```
+
+也可以在 CI 中临时设置 `BEST_REVIEW_GITLAB_ENABLED=true`。只有上传开关开启时，`review-mr` 才会要求 `GITLAB_TOKEN`；否则它只读取 MR 并输出本地结果。
+
+`review-mr` 会使用内置的 `BEST_REVIEW_HISTORY_USER_TOKEN` 读取 MR。`BEST_REVIEW_HISTORY_REMOTE`、`BEST_REVIEW_HISTORY_BRANCH`、`GITLAB_HOST` 已内置默认值，无需再写入项目 `.env`。
 
 可选变量：
 
 | 变量 | 说明 |
 | --- | --- |
-| `BEST_REVIEW_HISTORY_USER_TOKEN` | 读取 MR 和解析 GitLab 用户的内置 token |
-| `GITLAB_TOKEN` | 发布 MR discussion 的 token，需要用户自行配置 |
-| `GITLAB_HOST` | GitLab API host 覆盖值；可传 `https://gitlab.example.com` 或完整 `/api/v4` |
-| `BEST_REVIEW_GITLAB_ENABLED` | 本地 `review` 模式下设置为 `true` 时启用 GitLab Reporting |
+| `BEST_REVIEW_HISTORY_USER_TOKEN` | 已内置的 review 记录 token；如需临时替换，可通过环境变量覆盖 |
+| `GITLAB_TOKEN` | 发布 MR discussion 的 token；仅在上传开关开启时需要 |
+| `GITLAB_HOST` | GitLab API host 覆盖值；默认 `https://git.bestfulfill.tech`，可传完整 `/api/v4` |
+| `BEST_REVIEW_GITLAB_ENABLED` | GitLab discussion 上传开关；设置为 `true`/`false` 可覆盖 `gitlab.uploadEnabled` |
 | `GITLAB_PROJECT_ID` / `CI_PROJECT_ID` | 非 `review-mr` 模式下用于定位项目 |
 | `GITLAB_MR_IID` / `CI_MERGE_REQUEST_IID` | 非 `review-mr` 模式下用于定位 MR |
 
@@ -485,19 +501,21 @@ best-review review --base origin/main --json
 
 报告包含仓库信息、模型、风险结论、质量评分、最终问题和 diff 摘要。默认不保存完整 diff。
 
-如果想把本地 review 结果归档到 Git 仓库，配置自己的仓库地址即可启用历史归档：
+默认只保留本地报告，不再因为配置了历史仓库地址而自动上传远端。如果确需把本地 review 结果归档到 Git 仓库，需要显式开启：
 
 ```bash
-BEST_REVIEW_HISTORY_REMOTE=git@git.example.com:team/review-history.git
-BEST_REVIEW_HISTORY_BRANCH=review-log
+BEST_REVIEW_HISTORY=true
 ```
 
-如需临时关闭历史归档，可以设置：
+历史归档默认使用源码内置地址和分支：
 
-```bash
-BEST_REVIEW_HISTORY=false
+```text
+BEST_REVIEW_HISTORY_REMOTE=https://git.bestfulfill.tech/jericho/review-history.git
+BEST_REVIEW_HISTORY_BRANCH=review-log
 ```
 
+也可以通过环境变量覆盖为自己的仓库地址和分支。
+
 上传后的文件会按项目和 GitLab 用户分组：
 
 ```text
@@ -513,13 +531,14 @@ projects/<group>/<project>/<gitlab-user>/<timestamp>-<run-id>.json
 ```json
 {
   "reporting": {
+    "historyEnabled": true,
     "historyRemote": "git@git.example.com:team/review-history.git",
     "historyBranch": "review-log"
   }
 }
 ```
 
-`historyEnabled` 仍可显式设置为 `true`；配置了 `historyRemote` 时不再需要额外开启。
+`historyEnabled` 需要显式设置为 `true` 才会开启历史归档；仅配置 `historyRemote` 不会自动上传。
 
 如果还需要把报告 POST 到内部效能系统，再配置 Reporting URL：