This commit is contained in:
18
docs/配置说明.md
18
docs/配置说明.md
@@ -1,8 +1,8 @@
|
||||
# 缓存序列化结构检测 — 配置说明
|
||||
# 序列化结构检测 — 配置说明
|
||||
|
||||
> **双层配置**:工具 jar 内置 `default-config.yaml`(默认) + 业务仓库 `.gitea/config/cache-schema-check-config.yaml`(覆盖)
|
||||
> 工具坐标:`com.codechecker:cache-schema-checker:1.0.0`
|
||||
> 主类:`com.codechecker.cache.cli.CacheSchemaCheckerMain`
|
||||
> **双层配置**:工具 jar 内置 `default-config.yaml`(默认) + 业务仓库 `.gitea/config/serialization-schema-check-config.yaml`(覆盖)
|
||||
> 工具坐标:`com.codechecker:serialization-schema-checker:1.0.0`
|
||||
> 主类:`com.codechecker.cache.cli.SerializationSchemaCheckerMain`
|
||||
|
||||
---
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
```text
|
||||
jar 内 default-config.yaml(工具仓维护)
|
||||
↓ 深度合并
|
||||
业务仓 cache-schema-check-config.yaml(业务仓维护)
|
||||
业务仓 serialization-schema-check-config.yaml(业务仓维护)
|
||||
↓
|
||||
最终生效配置
|
||||
```
|
||||
@@ -23,7 +23,7 @@ jar 内 default-config.yaml(工具仓维护)
|
||||
### 1.1 业务仓最小配置示例
|
||||
|
||||
```yaml
|
||||
# jnpf-java-cloud/.gitea/config/cache-schema-check-config.yaml
|
||||
# jnpf-java-cloud/.gitea/config/serialization-schema-check-config.yaml
|
||||
enabled: true
|
||||
mode: notify
|
||||
|
||||
@@ -78,7 +78,7 @@ notify:
|
||||
# 无变更时是否也发通知(一般 false)
|
||||
notify_on_clean: false
|
||||
# 消息标题前缀
|
||||
title_prefix: "[缓存结构变更]"
|
||||
title_prefix: "[序列化结构变更]"
|
||||
|
||||
# 忽略规则
|
||||
ignore:
|
||||
@@ -182,7 +182,7 @@ mode: block
|
||||
| `webhook_url` | string | `""` | 企微机器人 Webhook 完整 URL(优先) |
|
||||
| `webhook_env` | string | — | 兼容旧字段;值为 `http` 开头时当作 URL |
|
||||
| `notify_on_clean` | boolean | false | 无变更时是否通知 |
|
||||
| `title_prefix` | string | [缓存结构变更] | 消息标题前缀 |
|
||||
| `title_prefix` | string | [序列化结构变更] | 消息标题前缀 |
|
||||
|
||||
### 3.4 ignore.key_patterns
|
||||
|
||||
@@ -299,7 +299,7 @@ suppressions:
|
||||
### 5.3 示例(已解析 key)
|
||||
|
||||
```markdown
|
||||
## [缓存结构变更] jnpf-java-cloud
|
||||
## [序列化结构变更] jnpf-java-cloud
|
||||
|
||||
> **分支**: code/redis_change_detection_v1.0
|
||||
> **提交**: cedd161c → 67c8a6eb
|
||||
|
||||
Reference in New Issue
Block a user