使用 `conventional-changelog` 生成 CHANGELOG 教程

使用 conventional-changelog 生成 CHANGELOG 教程

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

1、项目介绍

conventional-changelog 是一个开源工具，用于根据项目的 commit 信息和元数据自动生成 CHANGELOG 和发布说明。它遵循 Angular 提交消息规范，可以轻松地集成到 CI/CD 流程中，帮助开发者自动化版本管理和文档生成。

2、项目快速启动

安装

首先，你需要安装 conventional-changelog 工具：

npm install -g conventional-changelog-cli

生成 CHANGELOG

在你的项目根目录下运行以下命令来生成或更新 CHANGELOG 文件：

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

集成到 CI/CD

你可以在 CI/CD 流程中添加以下步骤来自动生成 CHANGELOG：

steps:
  - name: Generate CHANGELOG
    run: conventional-changelog -p angular -i CHANGELOG.md -s

3、应用案例和最佳实践

应用案例

假设你有一个前端项目，每次发布新版本时都需要手动更新 CHANGELOG。使用 conventional-changelog 后，你可以通过提交规范化的 commit 消息来自动生成 CHANGELOG。

最佳实践

1. 规范化 Commit 消息：确保团队成员遵循 Angular 提交消息规范。
2. 自动化流程：将 CHANGELOG 生成步骤集成到 CI/CD 流程中，减少手动操作。
3. 版本管理：结合 commit-and-tag-version 工具，自动管理版本号和标签。

4、典型生态项目

commitizen

commitizen 是一个帮助你编写规范化 commit 消息的工具：

npm install -g commitizen
commitizen init cz-conventional-changelog --save-dev --save-exact

commitlint

commitlint 用于检查 commit 消息是否符合规范：

npm install --save-dev @commitlint/config-conventional @commitlint/cli
echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

husky

husky 可以在提交前运行脚本，确保 commit 消息符合规范：

npm install husky --save-dev
npx husky install
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

通过这些工具的组合使用，你可以实现从 commit 消息到 CHANGELOG 生成的全自动化流程。

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