使用 conventional-changelog-cli 高效生成变更日志，解决重复提交难题
2024-03-09 13:44:34
使用 conventional-changelog-cli 有效生成变更日志
作为一名技术作家和经验丰富的程序员，我经常需要生成变更日志，以记录软件项目的变更和更新。conventional-changelog-cli 是一款极好的工具，可帮助我们自动化这一过程，并遵循约定化的提交规范。
简介
conventional-changelog-cli 是一款命令行工具，可生成变更日志。它通过解析遵循特定提交规范的提交消息，将这些消息转换为有意义的变更日志条目。这些规范包括 Angular、Commitizen 和 GitLab Flow。
问题：重复的提交
在使用 conventional-changelog-cli 时，我遇到一个常见问题：当生成变更日志时，它会重复显示较早版本中包含的提交内容。这会让变更日志变得冗长且难以阅读。
解决方案：配置 .conventionalrc 文件
要解决此问题，我们可以通过配置 .conventionalrc 文件来让 conventional-changelog-cli 忽略已发布版本中的提交。具体步骤如下：
- 创建
.conventionalrc文件 ：在项目根目录中创建一个名为.conventionalrc的 JSON 文件。 - 添加配置 ：在
.conventionalrc文件中添加以下配置：
{
"releaseCount": 1
}
解释
releaseCount 选项指定了 conventional-changelog-cli 在生成变更日志时应该考虑的发布版本数量。将其设置为 1 意味着它只会在当前发布版本中包含提交。
案例演示
以下是配置后的 conventional-changelog-cli 生成的变更日志示例：
# 1.0.0 (2023-05-18)
### Features
- Added feature A (commit: 123456)
- Added feature B (commit: 654321)
### Fixes
- Fixed bug X (commit: 987654)
- Fixed bug Y (commit: 321654)
正如你所看到的，变更日志只包含了当前发布版本中的提交，避免了重复。
常见问题解答
- 为什么我应该使用 conventional-changelog-cli？
conventional-changelog-cli 可以自动化变更日志的生成过程，并确保变更日志遵循一致的格式，从而节省时间并提高变更日志的可读性。
- 它支持哪些提交规范？
conventional-changelog-cli 支持多种提交规范，包括 Angular、Commitizen、GitLab Flow 和其他自定义规范。
- 如何自定义变更日志格式？
你可以使用 -p 选项指定一个预设的变更日志格式，或使用 -f 选项提供一个自定义的格式文件。
- 如何忽略某些提交？
你可以使用 -i 选项指定一个忽略文件，其中包含应该被忽略的提交。
- 如何贡献代码？
conventional-changelog-cli 是一个开源项目。欢迎通过提交拉取请求或报告问题来贡献代码。
总结
conventional-changelog-cli 是一款强大的工具，可以帮助我们生成清晰且一致的变更日志。通过配置 .conventionalrc 文件，我们可以避免重复的提交，从而使变更日志更易于阅读和理解。
