使用 Git 中的 Changelog 生成工具可以帮助我们更加方便地生成项目的更新日志。下面是在 Git 中使用 Changelog 生成工具的步骤:
conventional-changelog-cli
工具:npm install -g conventional-changelog-cli
changelog.config.js
配置文件:module.exports = {
// 指定生成日志的范围
// 例如只生成最近一次提交的日志
// preset: 'angular',
// releaseCount: 1,
// type: 'all',
// 生成日志的规则
// conventional-changelog 提供了多种预设规则
// preset: 'angular',
// 自定义规则
// conventional-changelog 提供了多种预设规则
// 也可以根据自己的需求自定义规则
// 参考文档:https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#options
config: {
// 自定义规则
}
};
package.json
中添加 changelog
脚本:"scripts": {
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
}
其中 -p
参数指定采用预设规则,这里使用 Angular 的规则;-i
参数指定生成日志的输出文件名为 CHANGELOG.md
;-s
参数指定将生成的日志写入输出文件之前将其添加到文件的开头。
npm run changelog
CHANGELOG.md
文件:git add CHANGELOG.md
git commit -m "chore: update changelog"
通过以上步骤,我们就可以方便地在 Git 中使用 Changelog 生成工具了。需要注意的是,conventional-changelog-cli
工具提供了多种预设规则,也可以根据自己的需求自定义规则,详情请参考官方文档。