该工具针对一些需要手动输入更新日志的项目,实现自动化输出更新日志,并且对更新日志进行内容格式化,便于后期维护,目前主要有以下几个功能模块。
- cz -- 定制化 git 提交
- log -- 自动生成 CHANGELOG.MD 日志文件
- lint -- 校验 commit 信息
cnpm i commitizen --save-dev
{
...
"config": {
"commitizen": {
"path": "./node_modules/jimi-web-changelog/lib/cz"
}
},
}
{
"cz": "git add . && git cz"
}
按照提示正确输出 commit 信息内容,如下示例:
cnpm i conventional-changelog-cli --save-dev
{
...
"script": {
"log": "conventional-changelog --config node_modules/jimi-web-changelog/lib/log -i CHANGELOG.md -s -r 0",
}
}
cnpm i husky commitlint --save-dev
{
...
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
},
}
具体配置可以参考 commitlint 官方,例子:
module.exports = Object.assign({}, require('jimi-web-changelog/lib/lint'), {
rules: {
'subject-empty': [2, 'never'],
'type-empty': [2, 'never'],
'type-enum': [2, 'always',
[
'新功能',
'修复',
...
]
]
}
}
可以搭配 husky 和 lint-stage 效果更佳。它能在你每次提交代码前校验你的代码格式并修复错误的代码格式,具体配置可以参考当前根目录下的 package.json 和 .eslintrc.
应该没有文件内容变动还执行 git add . 提交导致的。试着对项目进行更改再保存试试。
只有每次版本迭代的的时候才会更新这一次的日志信息。可以尝试打个标签最为封版。
可以试试安装 xcode.
xcode-select --install
版本号目前支持的格式为 vX.X.X,👀格式对吗?
如果该项目使用了 webpack,可以使用 markdown-loader.