介绍
conventional-changelog-cli 是一个用于生成规范化的 changelog 的 npm 包。该包可以根据提交信息自动生成 changelog,支持多种 commit 规范,例如 Angular、Ember 等。
本文将详细介绍如何安装和使用 conventional-changelog-cli。
安装
首先需要全局安装 conventional-changelog-cli:
npm install -g conventional-changelog-cli
使用
初始化
运行以下命令来初始化 conventional-changelog:
conventional-changelog -i CHANGELOG.md -s
该命令将在当前目录下创建一个名为 CHANGELOG.md 的文件,并将最新的提交信息写入其中。-s 参数表示将生成的内容写入文件而不是终端。
更新
运行以下命令来更新 changelog:
conventional-changelog -i CHANGELOG.md -s -r 0
-r 参数表示远程仓库地址,0 表示使用当前分支作为版本号。该命令会查找所有未记录到 CHANGELOG.md 中的提交信息,并将其添加到文件中。
格式化
运行以下命令来格式化 changelog:
conventional-changelog -i CHANGELOG.md -s -r 0 -p angular
-p 参数表示使用哪个 commit 规范进行格式化。例如使用 Angular 规范,该命令会将 CHANGELOG.md 文件按照规范格式化。
示例代码
以下是使用 Angular 规范的示例提交信息:
feat: 添加一个新的特性 该特性将会用于... BREAKING CHANGE: 该特性不兼容旧版本
该提交信息可以生成以下 changelog:
-- -------------------- ---- ------- -- ------------ --- ----- - -------- --------------------------------------------------------- -- ------- - ---------- --- -------- ------- - --------- --- -------- - -------- ---------------------------------------------------------
结论
conventional-changelog-cli 是一个非常有用的 npm 包,可以帮助前端开发人员自动生成规范化的 changelog。熟练掌握其使用方法对于团队协作和项目管理都有很大的帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/47445