git commit自动生产chagelog

2019-11-22

Commitizen

Commitizen是一个撰写合格 Commit message 的工具

然后，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。

1	$ commitizen init cz-conventional-changelog --save --save-exact

以后，凡是用到git commit命令，一律改为使用git cz。这时，就会出现选项，用来生成符合格式的 Commit message。

校验commit messgae格式

安装lint工具

# commit lint工具
npm i @commitlint/cli -D
# commit lint 常用配置
npm i @commitlint/config-conventional -D
# 安装husky，以在commit message时触发检验规则
npm i husky

配置husky

"husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
}

在package.json中加入配置（还可以通过commitlint.config.js，.commitlintrc.js，.commitlintrc.json，或.commitlintrc.yml文件等方式配置）：

module.exports = {
  // commit lint校验规则继承
  extends: ['@commitlint/config-conventional'],
  // 自定义校验规则
  rules: {},
};

配置完成后，每次commit就会进行校验，校验不通过会拦截commit

生成Change log

https://www.conventionalcommits.org/en/v1.0.0/

conventional-changelog 就是生成 Change log 的工具，运行下面的命令即可：

$ npm install -g conventional-changelog-cli
$ cd my-project

# 不会覆盖以前的 Change log，只会在 CHANGELOG.md 的头部加上自从上次发布以来的变动
$ conventional-changelog -p angular -i CHANGELOG.md -s

# 生成所有发布的 Change log
$ conventional-changelog -p angular -i CHANGELOG.md -s -r 0

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

{
  "scripts": {
    "release": "conventional-changelog -p angular -i CHANGELOG.md -s",
    "log": "conventional-changelog -p angular -i docs/CHANGELOG.md -s && git add docs/CHANGELOG.md",
    "logAll": "conventional-changelog -p angular -i docs/CHANGELOG.md -s -r 0 && git add docs/CHANGELOG.md"
  }
}