npm 包 git-changelog-updated 使用教程

阅读时长 2 分钟读完

什么是 git-changelog-updated

git-changelog-updated 是一个能够轻松生成git仓库的更改日志的 npm 包,可以按照你的需要自定义各种过滤规则和输出格式,是一个十分好用的工具。

安装 git-changelog-updated

安装 git-changelog-updated 不是一件困难的事情,使用 npm 即可完成:

如何使用

创建配置文件

在项目根目录下创建一个名为 "changelog.yaml" 的配置文件,内容如下:

修改 package.json 文件

在 package.json 文件中添加以下内容:

执行命令

在命令行执行以下命令:

生成的 CHANGELOG.md 文件会如你的配置所示呈现。

自定义配置

git-changelog-updated 提供了很多配置项供你选择,其中比较常用的配置项有下列几个:

  • output:输出的文件名
  • sortTags:标签排序规则,支持自定义 acs(升序)和 desc(降序)两种排序方式
  • template:输出格式,支持 compactfull 两种格式

结束语

通过本文的介绍,你已经了解了 git-changelog-updated 的基本用法。希望这个小工具能够对你更好的进行版本管理、发布管理带来帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600562a381e8991b448dfd8f

纠错
反馈