DSH VERTICAL KIT · 发布说明检查 / 更新日志检查

发布说明检查清单

它决定一件事:这份发布说明是否交代了哪个版本、何时、什么会坏、怎么迁移。

检查规则

规则判定
version-missing没有版本号标题(## 1.2.0 / ## v1.2.0)或「版本:」行 → error
date-missing全文没有完整日期 → error
order更新的版本标题出现在更旧版本之后 → error,报两处
breaking-without-upgrade声明了破坏性变更但没有升级/迁移段 → error(读者被留在原地)
upgrade-missing没有升级/迁移说明 → warn(信息里写明:没有破坏性变更就忽略)

用法

npx release-notes-check notes.md --json
npx release-notes-check notes.md --no-require-upgrade

真实输入输出

输入
# Changelog

## 2.1.0 — 2026-11-17

### Breaking

- 配置文件键「endpoint」改名「server」

## 1.9.0 — 2026-10-01

- 修了几个问题
$ release-notes-check release-sample.md
error breaking-without-upgrade 第0行 声明了破坏性变更但没有升级/迁移说明——读者被留在原地
warn upgrade-missing 第0行 没有升级/迁移说明(认得:## 升级、## 迁移、upgrade guide)——如果这次没有破坏性变更,忽略这条
fail: 2 version headings, 1 errors, 1 warnings

出口码:1。输出为真实 CLI 运行的逐字结果,由测试与工具保持同步。

出口码:0 干净、1 有发现、2 用法或读文件错误。--json 输出机器可读结果。DSH 内同样的函数在 POST /release-notes-check/api({"text":"…"} 或 {"path":"…"}),面板与 CI 调同一实现。

这是清单,不是专业人士。合同检查不是法律意见,发票检查不判税务合规,listing 检查不判商业价值。每条发现都是文本里可判定的结构缺陷,带行号。
只验书记层面,不验软件质量:它验证说明写了哪个版本、何时、什么会坏、怎么迁移;排序规则读标题顺序,「重点优先」式的故意乱序页不在规则域内。 · dsh-vertical-kit · 通用检查(哈希/引用/结构/表格/数字)在 dsh-verify-kit