npm 包 cz-conventional-changelog 使用教程

简介

cz-conventional-changelog 是一个使用 conventional-changelog 规则来生成 changelog 的工具。

它可以帮助你在提交代码时，自动生成符合规范的 commit message，并且可以根据这些 commit message 自动生成 CHANGELOG。这样可以提高团队协作效率，更好地记录项目开发历程和版本更新情况。

安装

npm install -g cz-conventional-changelog

配置

方法一：全局配置

在命令行中输入以下命令：

echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

方法二：项目级配置

在项目的 package.json 文件中添加以下配置：

{
  "config": {
    "commitizen": {
      "path": "cz-conventional-changelog"
    }
  }
}

使用

使用 cz-conventional-changelog 代替 git commit 命令，即可生成符合规范的 commit message。

git add .
git cz

此时会出现一个交互式界面，要求填写 commit message 相关信息。按照提示填写后，commit message 就会生成并提交到 git。

示例

例如，我们要提交一个新功能，并生成对应的 commit message 和 changelog。

1. 首先，在本地修改代码，完成新功能。

2. 使用 git add 命令将修改后的文件加入缓存区。

git add .

1. 使用 git cz 命令代替 git commit，按照提示填写 commit message 相关信息。

git cz

1. 填写完毕后，commit message 如下所示：

feat: 添加新功能

添加了一个新功能，可以实现 xxx 功能。

BREAKING CHANGE: 修改了原有的某些接口，需要重新修改调用方式。

1. 提交 commit message 到 git。

git push origin main

1. 最后，使用以下命令生成 changelog。

conventional-changelog -p angular -i CHANGELOG.md -s

以上示例中，我们使用了 feat 类型的 commit message。根据 conventional-changelog 规范，feat 表示添加新功能；而 BREAKING CHANGE 则表示这次提交有不兼容变更。

结语

cz-conventional-changelog 可以帮助我们在团队协作中更好地记录项目开发历程和版本更新情况，提高团队协作效率。通过使用本文介绍的方法，您可以轻松地使用这个工具，并生成符合规范的 commit message 和 changelog。

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