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

1. 项目介绍

Conventional Changelog 是一个用于从项目的提交消息和元数据生成变更日志和发布说明的开源工具。它遵循约定式提交规范，帮助开发者自动化版本管理和发布流程。Conventional Changelog 项目采用 monorepo 管理方式，包含多个 npm 包，提供了丰富的插件和工具支持。

2. 项目快速启动

安装

首先，确保你已经安装了 Node.js 和 npm。然后，通过 npm 安装 commit-and-tag-version 库：

npm install commit-and-tag-version --save-dev

配置

在项目的根目录下创建一个 .commitlintrc.js 文件，配置提交消息的规范：

module.exports = {
  extends: ['@commitlint/config-conventional'],
};

使用

在项目中使用 commit-and-tag-version 命令来生成变更日志和版本标签：

npx commit-and-tag-version

该命令会自动根据提交消息生成变更日志，并更新项目的版本号。

3. 应用案例和最佳实践

应用案例

假设你正在开发一个开源项目，希望自动化版本管理和发布流程。你可以使用 Conventional Changelog 来生成变更日志，并结合 CI/CD 工具自动发布新版本。

最佳实践

1. 提交消息规范：确保团队成员遵循约定式提交规范，提交消息格式为 type(scope): subject，例如 fix(auth): 修复登录验证错误。
2. 自动化发布：结合 semantic-release 工具，实现从提交消息到自动发布的全流程自动化。
3. 持续集成：在 CI/CD 流程中集成 Conventional Changelog，每次提交代码时自动生成变更日志。

4. 典型生态项目

4.1 Conventional Changelog CLI

Conventional Changelog CLI 是一个功能齐全的命令行接口，支持多种提交消息格式，适用于需要自定义变更日志格式的项目。

4.2 Conventional GitHub Releaser

Conventional GitHub Releaser 是一个用于从 Git 元数据生成 GitHub 发布的工具，适用于需要在 GitHub 上自动发布新版本的项目。

4.3 Commitizen

Commitizen 是一个简单的提交规范工具，帮助开发者遵循约定式提交规范，适用于需要规范化提交消息的项目。

4.4 Commitlint

Commitlint 是一个提交消息校验工具，用于确保提交消息符合约定式提交规范，适用于需要强制执行提交规范的项目。

通过以上模块的介绍和实践，你可以快速上手并应用 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