Skip to content

FrontEndDev-org/changelog-splitter

Repository files navigation

changelog-splitter

✂️ conventional commit changelog markdown splitter 约定式提交更新日志 markdown 切割器

code-review dependency-review Codacy Badge Codacy Badge npm version

使用

npm install -D changelog-splitter

假设有一个很长的 CHANGELOG.md,包含了从 1.x 到 4.x 的所有版本信息:

# 更新日志

## v4.x.x

...中间有 4.x - 1.x 的版本信息

# 1.x.x

同目录必须有 package.json 文件,其内容为:

{
  "name": "my-project",
  "version": "4.5.6"
}
changelog-splitter

执行过程中打印如下:

正在进行更新日志文件切割...

解析 [========================================] 100%
引用 [========================================] 100%

更新日志文件变化情况如下(删除标记“-”的文件需要手动删除):
~ CHANGELOG.md
+ changelogs/v1.x-CHANGELOG.md
+ changelogs/v2.x-CHANGELOG.md
+ changelogs/v3.x-CHANGELOG.md

更新日志切割成功

此时的 CHANGELOG.md 里内容如下:

# 更新日志

## v4.x.x

...中间只有 4.x 的版本信息,根据 package.json 里的版本号决定

## 其他版本的更新日志
- [v3.x](changelogs/v3.x-CHANGELOG.md)
- [v2.x](changelogs/v2.x-CHANGELOG.md)
- [v1.x](changelogs/v1.x-CHANGELOG.md)

链接