侧边栏壁纸
  • 累计撰写 21 篇文章
  • 累计创建 11 个标签
  • 累计收到 9 条评论

Vue 根据git commit记录生成CHANGELOG.md文档

好巧
2023-08-29 / 1 评论 / 1 点赞 / 76 阅读 / 2200 字
温馨提示:
本文最后更新于 2023-11-22,若内容或图片失效,请留言反馈。部分素材来自网络,若不小心影响到您的利益,请联系我们删除。

前言

生成 CHANGELOG.md 需要符合 git commit 提交规范,规范配置请查看另一篇文章 Vue 代码提交github前commit message校验规范

1.安装依赖

yarn add conventional-changelog conventional-changelog-cli --dev

2.配置 package.json 的 scripts 字段

"scripts": {
  ...
  "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
}

说明

  • -p angular:指定使用的 commit message 标准

  • -i CHANGELOG.md:指定输出的文件名称

  • -s:指定读写同一文件

  • -r 0:指定增量更新,不会覆盖以前的更新

3.自定义 CHANGELOG.md 配置

1.根目录新建 .changelog.config.js

请参考官方配置项: writerOpts.js

2.修改 changelog 配置项

"scripts": {
  ...
  "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0  -n ./.changelog.config.js"
}

-n ./.changelog.config.js: 自定义配置文件

3.生成 CHANGELOG.md

yarn changelog

1

评论区