提供了一种基于commitizen的git commit信息规范化的方式，用于创建项目的CHANGELOG.md。这个规范的设计目的是为了生成人类可读的CHANGELOG，同时也非常适合与自动化发布工具（如CI/CD）合作使用。在这篇文章中，我们将为你提供使用@talentui/cz-project-changelog的详细教程，以及示例和指导。
安装
可以使用npm或者yarn安装@talentui/cz-project-changelog：
# use npm npm install --save-dev @talentui/cz-project-changelog # or use yarn yarn add --dev @talentui/cz-project-changelog
配置
@talentui/cz-project-changelog支持通过以下方式配置：
使用步骤
- 在
package.json中添加changelogConfig：
{
"changelogConfig": {
"message": "---",
"path": "./CHANGELOG.md",
"updateUrl": "{repoUrl}/compare/{previousTag}...{currentTag}"
}
}- 在
.czrc中通过adapter来引用@talentui/cz-project-changelog：
{
"path": "@talentui/cz-project-changelog"
}配置参数解释
message: 可以是字符串，也可以是包含注释的字符串数组，表示引用commitizen的提示信息（也就是我们平常提交代码时会看到的信息）。path: 要更新的CHANGELOG文件路径。如果文件不存在，将会自动创建。如果文件已存在，将在末尾以标准格式追加内容。updateUrl: Github或Gitlab等版本控制平台的compare URL格式，用于在CHANGELOG文件中插入一个链接，让读者可以跳转到某个特定的commit或PR。可以使用{repoUrl}、{previousTag}、{currentTag}等变量占位符，在提交代码时将被替换成实际的值。
调用
完成以上配置后，可以通过以下命令来使用@talentui/cz-project-changelog来提交git：
$ git cz
执行该命令后，将会进入提交信息输入界面，按照提示依次填入信息即可。
以下是一个示例输出：
-- -------------------- ---- ------- -- ---------------------- - ----------------------- - --- - -- - ------------------- - ------------- --- -- - ------- - ------- - --- --- -- - ----------- - ------------- - --- --- -- - --------- - ------------- - --- --- -- - ---------- - ----- - ---
结论
如此，我们已经完成了@talentui/cz-project-changelog的安装，配置，调用以及示例。如果您正在寻找一种规范化的提交信息格式，并且希望能够自动生成CHANGELOG文件，那么@talentui/cz-project-changelog就是您不错的选择。祝您使用愉快！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/89244