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

原创已于 2024-01-19 10:19:44 修改 · 1.6k 阅读

CC 4.0 BY-SA版权

文章标签：

于 2021-10-20 15:33:12 首次发布

34 篇文章

订阅专栏

12 篇文章

订阅专栏

本文介绍了如何使用conventional-changelog和conventional-changelog-cli在Vue项目中生成符合Angular commit规范的CHANGELOG.md，包括安装依赖、配置package.json、自定义配置和生成过程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

本文基于

生成 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

在这里插入图片描述

如果本篇文章对你有帮助的话，很高兴能够帮助上你。

当然，如果你觉得文章有什么让你觉得不合理、或者有更简单的实现方法又或者有理解不来的地方，希望你在看到之后能够在评论里指出来，我会在看到之后尽快的回复你。