如果所有commit都符合Angular格式,则发布新版本时,Change log可以使用脚本自动生成。

生成文档包括3个部分:

  • New features

  • Bug fixes

  • Breaking changes

每个部分都会罗列相关commit,并指向commit链接,生成的文档可以手动修改。

conventional-changelog是生成Change log的工具

$ npm install -g conventional-changelog
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -w

上面命令不会覆盖以前的Change log,只会在CHANGELOG.md头部加上自从上次发布以来的变动。

如果想要生成所有发布的Change log,需要修改

$ conventional-changelog -p angular -i CHANGELOG.md -w -r 0

为方便使用,可以将其写入package.json的scripts字段

{
  "scripts": {
    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
  }
}

直接运行命令

npm run changelog

results matching ""

    No results matching ""