feat: 文档更新

This commit is contained in:
2026-07-14 17:11:58 +08:00
parent 6e06cbf5b5
commit 1f119edb7c
3 changed files with 190 additions and 122 deletions

View File

@@ -15,9 +15,9 @@ Gitea Actions 触发
java -jar 执行(对比 HEAD~1 与 HEAD
P0/P1 变更 → 企微通知
结构变更 → 企微通知(按 Key 骨架;删除橙/新增绿)
mode=block 且含 P0/P1/P2 任一变更 → exit 1流水线失败
mode=block 且含任意结构变更 → exit 1流水线失败
```
---
@@ -29,7 +29,6 @@ mode=block 且含 P0/P1/P2 任一变更 → exit 1流水线失败
| Gitea Runner | 标签 `jdk11`,已安装 Java 11 |
| Nexus 私库 | 可访问 `http://192.168.3.25:18081/nexus/repository/maven-releases` |
| 工具 JAR | `com.codechecker:cache-schema-checker:1.0.0` 已发布 |
| 仓库 Secret | `WECOM_ROBOT_WEBHOOK` 已配置 |
---
@@ -140,7 +139,6 @@ jobs:
| `code-check` (CodeChecker) | 通用变更检测 | **同模式**,可并列执行 |
| `cache-schema-check` | 缓存结构检测 | 新增 |
建议:三个 job 独立并行,各自 exit code 独立。
---
@@ -169,7 +167,7 @@ com/codechecker/cache-schema-checker/1.0.0/
| 退出码 | 含义 | 流水线表现 |
|--------|------|------------|
| 0 | 通过(含 notify 模式下的告警) | 绿色 |
| 1 | 阻断block 模式 + P0/P1/P2 任一变更 | 红色 |
| 1 | 阻断block 模式) | 红色 |
| 2 | 执行错误配置缺失、jar 异常等) | 红色 |
---
@@ -182,8 +180,8 @@ com/codechecker/cache-schema-checker/1.0.0/
| 下载 jar 失败 | Nexus 地址/版本错误 | 检查 env 变量 |
| 未收到企微 | Secret 未配 / notify.enabled=false | 检查配置 |
| 大量误报 | 锁/计数器未过滤 | 补充 ignore.key_patterns |
| 漏报 | 写入模式未覆盖 | 启用 W04/W05 或补充 manual_mappings |
| 类型展开不完整 | 类型在依赖 jar 中 | 补充 manual_mappings.value_type |
| 漏报 | 写入模式未覆盖 / 模块过滤过窄 | 确认 W01~W05 已启用;检查 `include_modules` |
| 类型展开不完整 | 类型在依赖 jar 中 | 补充 `manual_mappings.value_type` |
---
@@ -201,4 +199,4 @@ java -jar /path/to/cache-schema-checker-1.0.0.jar \
--modify-time "$(git log -1 --format=%cd --date=format:'%Y-%m-%d %H:%M:%S')"
```
可加 `--dry-run`Phase 2 实现)仅输出报告不发企微。
可加 `--dry-run` 仅输出报告不发企微。