standard-version：自动版本管理和CHANGELOG生成的利器

standard-version：自动版本管理和CHANGELOG生成的利器

standard-version :trophy: Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org 项目地址: https://gitcode.com/gh_mirrors/st/standard-version

项目介绍

standard-version 是一个基于 semver 规范和 Conventional Commits 的版本管理和CHANGELOG生成工具。它能够帮助开发者在遵循一定的提交规范的基础上，自动化地管理项目版本，并生成详细的变更记录。这对于维护项目历史、跟踪功能变更和优化项目管理流程来说至关重要。

项目技术分析

standard-version 的核心在于利用 Conventional Commits 提交信息来智能分析版本变更。它的工作流程主要包括：

1. 检索项目的当前版本，如果未指定，则回退到最后一个 git tag。
2. 根据 bumpFiles 中的文件和提交信息，自动“bump”版本。
3. 生成基于提交信息的 changelog。
4. 创建包含更新版本号和CHANGELOG的新 commit。
5. 创建一个新的 tag，标记新版本。

此外，standard-version 支持多种配置方式，包括在 package.json 中添加配置项或在项目根目录下创建 .versionrc 文件。这使得它非常灵活，可以适应不同项目的技术需求。

项目及技术应用场景

standard-version 主要适用于以下场景：

1. 自动化版本管理：在版本迭代过程中，自动根据提交信息进行版本号的升级，减少手动操作错误。
2. 生成标准化的CHANGELOG：自动生成的CHANGELOG能够清晰地展示每个版本的变化，便于用户和团队成员了解项目的发展历程。
3. 多语言和自定义文件支持：通过配置 updaters，standard-version 可以支持多种语言和版本文件，使其适用于各种类型的项目。

项目特点

以下是 standard-version 的几个主要特点：

• 遵循Conventional Commits规范：通过统一的提交格式，确保版本管理和CHANGELOG生成的一致性和可预测性。
• 灵活的配置选项：支持多种配置方式，适应不同项目需求，包括自定义版本文件、预发布版本和生命周期脚本等。
• 与主流工具集成：可以与 npm、git 等工具链无缝集成，提高开发效率。
• 兼容性和扩展性：通过插件和自定义配置，可以轻松扩展 standard-version 的功能，适应更多场景。

使用指南

安装

standard-version 可以通过以下几种方式进行安装：

1. 作为本地 npm run 脚本：

   npm i --save-dev standard-version
   

   在 package.json 中添加运行脚本：

   {
     "scripts": {
       "release": "standard-version"
     }
   }
   

2. 作为全局 bin：

   npm i -g standard-version
   

3. 使用 npx：

   npx standard-version
   

配置

你可以在 package.json 中添加 standard-version 配置节，或者创建 .versionrc、.versionrc.json 或 .versionrc.js 文件。配置项遵循 conventional-changelog-config-spec。

CLI 使用

以下是 standard-version 的一些常用命令：

• 首次发布：

  npm run release -- --first-release
  

• 常规发布：

  npm run release
  

• 预发布版本：

  npm run release -- --prerelease
  

• 指定发布类型：

  npm run release -- --release-as minor
  

• 防止验证 Git Hooks：

  npm run release -- --no-verify
  

• 签署提交和标签：

  npm run release -- --sign
  

通过使用 standard-version，开发者可以极大地简化版本管理和文档生成工作，确保项目迭代过程的规范性和效率。这个工具不仅适用于JavaScript项目，通过配置也能适应其他语言和版本文件，是一个值得推广的开源项目。

standard-version :trophy: Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org 项目地址: https://gitcode.com/gh_mirrors/st/standard-version