开源项目教程：使用 conventional-changelog 自动生成变更日志

开源项目教程：使用 conventional-changelog 自动生成变更日志

conventional-changelog项目地址:https://gitcode.com/gh_mirrors/co/conventional-changelog

项目介绍

conventional-changelog 是一个广受前端开发者喜爱的工具，它基于 commit 信息自动生成变更日志（CHANGELOG）。遵循一定的提交消息约定，如 Angular 提出的提交规范，它可以智能地分析每个提交，并据此构建清晰、结构化的变更列表。这大大简化了维护版本历史的工作量，确保每次发布都能伴随详细且准确的更改说明。

项目快速启动

要快速启动并使用 conventional-changelog，首先你需要安装它。这里以最常见的 CLI 使用方式为例：

npm install --save-dev conventional-changelog-cli

紧接着，你可以运行以下命令来自动生成初始的 CHANGELOG.md 文件，假设你的提交已经遵循了某种约定（例如 Angular 的约定）：

npx conventional-changelog -p angular -i CHANGELOG.md -s

这里的参数解释：

• -p angular 指定了遵循的提交规范为 Angular。
• -i CHANGELOG.md 指定生成的或追加到的文件名。
• -s 表示自动将生成的内容添加到暂存区（便于立即提交）。

首次运行可能会提示缺少 .czrc 配置文件，如果你使用的是默认的 Angular 提交格式，则无需额外配置。

应用案例和最佳实践

在团队协作的项目中，实施 commit 规范是使用 conventional-changelog 的前提。通常，建议结合使用 commitizen 来帮助团队成员更容易地创建符合规范的提交消息。此外，利用 husky 和 commitlint 可以在提交前强制检查消息格式，保证一致性。

最佳实践中，建立一套团队内部统一的提交规则，比如采用 Angular 或者其他的 commit 规范（如 Semantic Commit Messages），并且在项目初始化时即纳入这些工具和流程，可以显著提高项目维护效率。

典型生态项目

在 conventional-changelog 的生态系统里，有几个重要的辅助工具值得关注：

• commitizen: 提供了一种交互式的命令行界面，帮助开发者按照特定的提交规范填写提交信息。

• commitlint: 在 commit 之前进行检查，确保提交信息符合预设的格式规范。

• husky: 钩子管理器，可以在 Git 的某些生命周期节点（如 pre-commit）自动触发脚本，非常适合用来执行 commitlint。

通过上述工具的集成，可以构建一个完整的从提交规范化到自动生成变更日志的流程，确保软件维护的历史透明性和易于追踪。

---

以上就是使用 conventional-changelog 的基本教程及其生态系统的简要概述，遵循这些步骤，你的项目将拥有更加专业和系统的版本记录管理。

conventional-changelog项目地址:https://gitcode.com/gh_mirrors/co/conventional-changelog