56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
# 类变更通知模版
|
||
|
||
Push 触发 CI 后，按变更类的后缀（`Dto` / `Vo` / `Entity` / `Model`）选用对应模版生成企业微信 Markdown 通知。
|
||
|
||
## 企微语法说明
|
||
|
||
使用 webhook **`markdown`**（v1），支持 font 三色；**不支持无序列表**，故各项以**引用块 + 换行**分行展示。
|
||
|
||
| 语法 | 说明 |
|
||
|------|------|
|
||
| `#` / `##` / `###` | 标题 |
|
||
| `` `行内代码` `` | 字段名、URI |
|
||
| `>` | 引用行（每项一行） |
|
||
| `<font color="info">` | 绿：类名、新增、HTTP 方法、新类型 |
|
||
| `<font color="comment">` | 灰：说明、路径、无影响 |
|
||
| `<font color="warning">` | 橙：[修改]/[删除]、旧类型 |
|
||
|
||
## 布局约定
|
||
|
||
1. **# 类变更通知** — 头部 4 项，每项一行 `>标签:值`
|
||
2. **## 对象变更细节** — 每条变更独立引用块，字段间空行分隔
|
||
3. **## 影响范围** — 各 ### 小节内，每项一行引用
|
||
|
||
## 公共头部
|
||
|
||
```
|
||
# 类变更通知
|
||
|
||
> 变更对象:<font color="info">ApplyAttendanceChangeDto</font>（Dto）
|
||
> 修改人:<font color="comment">dongzi</font>
|
||
> 时间:<font color="comment">2026-06-07 20:14:35</font>
|
||
> 路径:<font color="comment">jnpf-ftb/.../ApplyAttendanceChangeDto.java</font>
|
||
```
|
||
|
||
## 影响范围
|
||
|
||
| 类类型 | request | response | 类转换 |
|
||
|--------|:-------:|:--------:|:------:|
|
||
| Dto | ✅ | ❌ | ✅ |
|
||
| Vo | ❌ | ✅ | ✅ |
|
||
| Entity / Model | ❌ | ❌ | ✅ |
|
||
|
||
## 模版文件
|
||
|
||
| 文件 | 场景 |
|
||
|------|------|
|
||
| [field-description.md](./field-description.md) | 字段说明与行格式 |
|
||
| [dto.md](./dto.md) | Dto |
|
||
| [vo.md](./vo.md) | Vo |
|
||
| [entity.md](./entity.md) | Entity |
|
||
| [model.md](./model.md) | Model |
|
||
|
||
## 实现
|
||
|
||
`WeComNotifier.buildMarkdown()` · 消息类型 `markdown` · 路径取自 `ClassChangeReport.sourceFile`
|