conventional-changelog-cli: 简化变更日志管理的利器

conventional-changelog-cli: 简化变更日志管理的利器

conventional-changelog-clideprecated, instead use https://github.com/conventional-changelog/conventional-changelog monorepo项目地址:https://gitcode.com/gh_mirrors/co/conventional-changelog-cli

项目介绍

conventional-changelog-cli 是一款基于 Git 提交消息和元数据来生成变更日志的工具。它遵循一定的提交规范，帮助开发者自动创建清晰且一致的 CHANGELOG.md 文件，从而简化了软件发布过程中手动维护变更记录的繁琐工作。此项目是开源社区的一个重要组成部分，特别是在推崇语义化版本控制（Semantic Versioning）的开发流程中。

项目快速启动

要开始使用 conventional-changelog-cli，您需先确保开发环境中已安装 Node.js。以下是快速集成的步骤：

安装依赖

通过 Yarn 或 npm 在您的项目中添加 conventional-changelog-cli 作为开发依赖：

yarn add conventional-changelog-cli --dev
# 或者，如果您偏好使用 npm
npm install conventional-changelog-cli --save-dev

配置脚本

编辑您的 package.json 文件，加入以下脚本来简化命令执行：

{
  "scripts": {
    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
  }
}

这里 -p angular 表示使用 Angular 提交消息约定，-i CHANGELOG.md 指定生成的日志文件名，-s 自动将日志添加到最近的提交中。

生成变更日志

运行以下命令即可生成或更新 CHANGELOG.md 文件：

yarn changelog

或者，如果是使用 npm:

npm run changelog

应用案例和最佳实践

使用 conventional-changelog-cli 的一个关键在于遵守提交消息的规范。推荐使用如 [type](scope): description 格式，例如 feat(user-profile): add new avatar upload feature，其中 feat 表示特性增加，(user-profile) 限定作用范围，描述简洁明了。这有助于工具正确解析并分类变更内容。

最佳实践中，结合使用 commitizen 工具可以引导开发者按照预设的模式填写提交消息，保证提交的一致性。

典型生态项目

在 conventional-changelog-cli 的生态系统中，有许多其他工具和服务与之配套，用于增强版本管理和提交文化：

• commitizen: 提供交互式的 CLI 来帮助开发者按照规范格式提交代码。
• commitlint: 在提交时检查消息是否符合既定规范，保障团队一致性。
• standard-version: 自动化版本号递增、标签创建和 CHANGELOG.md 更新的工具，非常适合语义化版本控制的项目。
• husky: 作为Git钩子管理器，在提交前自动执行诸如验证提交消息等任务，常与 commitlint 结合使用。

以上组件共同构建了一套高效的工作流，帮助团队在软件开发过程中维持高质量的代码管理和文档记录。通过整合这些工具，开发者不仅能够轻松维护变更日志，还能促进团队间的沟通与协作，提升整体的开发效率与项目质量。

conventional-changelog-clideprecated, instead use https://github.com/conventional-changelog/conventional-changelog monorepo项目地址:https://gitcode.com/gh_mirrors/co/conventional-changelog-cli