使用 conventional-changelog 完成自动化的更改日志生成

使用 conventional-changelog 完成自动化的更改日志生成

conventional-changelog Generate changelogs and release notes from a project's commit messages and metadata. 项目地址: https://gitcode.com/gh_mirrors/con/conventional-changelog

conventional-changelog 是一个强大的开源工具，旨在从你的项目中的提交消息和元数据自动生成变更日志和发行说明，极大地简化了版本控制管理和文档更新流程。

1. 项目介绍

conventional-changelog 采用一种标准化的提交信息格式，基于 Conventional Commits 规范。这个项目作为一个monorepo管理，内含多个npm包，支持高度定制化。它可以帮助团队通过分析git历史记录，生成格式统一的CHANGELOG.md文件，进而促进软件维护的透明性和可追溯性。

2. 项目快速启动

要迅速开始使用 conventional-changelog，你需要首先确保你的本地环境安装了Node.js，并已经配置了符合[Conventional Commits]的提交习惯。

安装

可以通过npm全局安装 conventional-changelog-cli:

npm install -g conventional-changelog-cli

生成CHANGELOG

假设你想基于最近的提交来生成或更新你的CHANGELOG.md文件，可以使用以下命令：

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

这里的参数解释如下：

• -p angular: 指定使用Angular的约定来解析提交信息。
• -i CHANGELOG.md: 指定CHANGELOG.md文件作为输入和输出。
• -s: 自动在最后添加一条分隔线。

如果你的项目已经有了一个初始的CHANGELOG.md文件，这将会在此基础上追加新的更改条目。

3. 应用案例和最佳实践

当你在一个新版本发布前执行上述命令时，conventional-changelog会智能地识别出自上次发布以来的所有相关提交，并按类型分类生成详细的变化日志。最佳实践包括：

• 遵守提交规范：始终遵循Conventional Commits的规则来撰写你的提交消息，例如使用feat:、fix:、BREAKING CHANGE:等前缀。
• 自动化集成：结合Git钩子或者CI/CD流程，在每次准备发布新版本之前自动运行conventional-changelog，以保持CHANGELOG.md的最新状态。
• 使用 Husky + CommitLint 进行提交合规检查，保证提交格式的一致性。

4. 典型生态项目

conventional-changelog生态中还包括了一些辅助工具，如commitizen用于帮助创建符合规范的提交，commitlint用于验证提交信息的格式，以及semantic-release进一步实现了基于提交内容自动判断版本号并发布的新高度。这些工具一起构建了一个全面的版本管理和文档更新生态系统，使得软件开发过程更加规范化和自动化。

通过整合这些工具，开发者可以实现从提交的那一刻起就为自动化发布流程做好准备，大大减少了手动维护变更日志的工作量，提高了开发效率和项目的专业度。

conventional-changelog Generate changelogs and release notes from a project's commit messages and metadata. 项目地址: https://gitcode.com/gh_mirrors/con/conventional-changelog