npm 包 @theo.gravity/changelog-version 使用教程

简介

@theo.gravity/changelog-version 是一个实用的 npm 包，用于自动管理项目版本号和生成更新日志。当开发新功能并更新版本号时，它会自动根据之前版本的更新情况生成一个可读的更新日志，并将其添加到项目的 changelog 中。

安装

这个 npm 包可以在命令行中轻松安装，只需要运行以下命令:

npm install --save-dev @theo.gravity/changelog-version

如何使用

下面是一些使用示例:

增加新功能

1. 在 package.json 中修改版本号即可:

"version": "0.2.0"

1. 运行以下命令：

npx cv --include-unreleased --head 5 -b bugfix

然后就会自动生成更新日志，并将其添加到 changelog 中。

添加一个 bugfix

1. 在 package.json 中增加版本号:

"version": "0.2.1"

1. 运行以下命令：

npx cv -b bugfix

根据当前版本和之前版本之间的差异，生成一个可读的更新日志，并将其添加到 changelog 中。

发布一个 release

1. 在 package.json 中增加版本号:

"version": "1.0.0"

1. 运行以下命令：

npx cv --include-unreleased -b bugfix -b feature

将生成一个包含所有先前的 bugfix 和 feature 的可读更新日志，并将其添加到 changelog 中。

参数说明

• --include-unreleased: 包含未发布的变更
• --head [num]: 显示最近的 num 条变更
• -b [branch]: 从指定分支获取变更。可以传入多个分支。

总结

使用 @theo.gravity/changelog-version 可以很方便地管理版本号和生成更新日志。它能够自动计算出相邻版本之间的差异，并生成可读的日志。这极大地加快了开发流程，并有助于团队之间更好的协作。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedbf65b5cbfe1ea0611be4