**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 是一个强大的工具，用于从Git元数据自动生成变更日志，简化了版本发布过程中手动维护CHANGELOG的繁琐工作。本文档旨在提供全面的指导，帮助开发者了解并高效利用此工具。

1. 安装指南

首先，确保你的开发环境已安装Node.js（推荐使用LTS版本）。通过npm（Node包管理器）安装Conventional Changelog及其相关依赖。对于快速启动，可以使用以下命令：

npm install --global conventional-changelog-cli

这将全局安装Conventional Changelog CLI，允许你在命令行直接使用它。

2. 项目的使用说明

快速生成Changelog

基础使用非常简单，进入你的项目目录后执行：

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

参数解释：

• -p angular：指定遵循Angular的提交约定。
• -i CHANGELOG.md：指定生成或更新的Changelog文件名。
• -s 或 --silent：抑制常规输出，仅输出到指定的文件。

集成到Git钩子

为了保证每次提交都符合约定，你可以集成Commitizen和Husky这样的工具来实现提交时的规范化。

1. 安装Commitizen和Husky：

   npm install --save-dev commitizen husky
   

2. 在项目根目录添加Husky配置到.huskyrc（或使用.huskyrc.js, .husky/config.js等）：

   {
     "prepare": "cz lint-staged"
   }
   

3. 设置Commitizen的配置文件cz-config.json：

   {
     "path": "cz-conventional-changelog"
   }
   

这样，在提交代码前，将强制执行提交消息的规范。

3. 项目API使用文档

对于更复杂的集成需求，你可以直接在项目中引入Conventional Changelog的API。例如，在JavaScript文件中：

const conventionalChangelog = require('conventional-changelog');

// 使用preset为angular的例子
conventionalChangelog({ preset: 'angular' })
  .pipe(process.stdout); // 输出到控制台

4. 项目安装方式

• 对于终端命令行使用，如上所述，使用npm install --global conventional-changelog-cli进行全局安装。
• 若在项目中直接作为依赖使用其API，可通过npm install --save conventional-changelog安装至项目本地。

总结

Conventional Changelog通过自动化流程极大地提高了维护版本记录的效率，特别适合遵循特定提交格式（如Angular Commit Guidelines）的项目。通过合理地集成到CI/CD流程中，更能够实现无缝的版本管理和发布过程。记得调整配置以满足特定项目的需求，并享受它带来的便捷吧！

---

请注意，上述步骤和配置应根据最新的包版本和最佳实践进行适当调整。务必查看项目的最新文档以获取任何可能的更新信息。

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