标准版本自动化工具使用教程

标准版本自动化工具使用教程

standard-version 项目地址: https://gitcode.com/gh_mirrors/st/standard-version

1. 项目介绍

standard-version 是一个用于自动化版本管理和 CHANGELOG 生成的开源工具。它基于 semver（语义化版本控制）和 Conventional Commits（传统提交信息）规范，能够帮助开发者在遵守一定提交信息格式的前提下，自动更新项目版本号并生成相应的变更日志。

2. 项目快速启动

在开始使用 standard-version 之前，确保你的项目遵循 Conventional Commits 提交信息规范。

安装

作为本地 npm 脚本

首先，将 standard-version 添加到项目的 devDependencies：

npm i --save-dev standard-version

然后，在 package.json 中添加一个 npm 脚本：

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

现在，你可以使用以下命令来代替 npm version：

npm run release

作为全局命令

如果你想要全局安装 standard-version，可以运行：

npm i -g standard-version

这样你可以在任何项目中使用 standard-version 而不需要每次都添加为依赖。

使用 npx

从 npm@5.2.0 开始，npx 与 npm 一起安装。使用 npx，你可以在没有 package.json 文件的情况下运行 standard-version：

npx standard-version

这在你使用非 JavaScript 项目时特别有用。

首次发布

为了生成你的首次发布变更日志，运行以下命令：

npm run release -- --first-release

或者如果你是全局安装的：

standard-version --first-release

这将为你的首次发布打上标签但不更新版本号。

切割发布

当你准备切割一个新发布时，运行：

npm run release

或者如果你是全局安装的：

standard-version

只要你的 git 提交信息是规范和准确的，你就不需要指定 semver 类型，并且会自动生成变更日志。

发布后，你可以推送新的 git 标签并使用 npm publish 来发布你的新版本。

3. 应用案例和最佳实践

• 遵循 Conventional Commits 规范：确保所有提交信息都遵循规范，这样可以保证 standard-version 能够正确地解析提交并进行版本更新。
• 自动化工作流程：利用 standard-version 的 CLI 参数和配置选项，可以将其集成到持续集成（CI）流程中，实现自动化的版本管理和发布。

4. 典型生态项目

standard-version 可用于任何遵循 Conventional Commits 规范的 JavaScript 项目。以下是一些可能用到 standard-version 的典型生态项目：

• 前端框架：如 React、Vue、Angular 等项目的插件或组件库。
• 后端服务：如 Node.js 的各种中间件或服务端框架。
• 命令行工具：任何需要版本管理和变更日志的 CLI 工具。

通过使用 standard-version，这些项目可以简化版本管理流程，提高开发效率。

standard-version 项目地址: https://gitcode.com/gh_mirrors/st/standard-version