standard-version 使用指南

standard-version 使用指南

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

1. 项目介绍

standard-version 是一个自动化版本控制和CHANGELOG生成的工具，基于semver（语义化版本控制）和Conventional Commits（传统提交信息）。它能够帮助开发者自动管理项目的版本号，并根据提交信息生成详细的项目变更记录。

2. 项目快速启动

在开始使用standard-version之前，确保你的项目已经配置了npm，并且有一个package.json文件。

安装

作为本地npm脚本：

npm i --save-dev standard-version

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

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

现在，你可以使用以下命令来触发版本发布：

npm run release

如果你希望全局安装standard-version，可以使用以下命令：

npm i -g standard-version

这样你就可以在任何项目中使用standard-version命令，而无需在每个项目中重复安装。

首次发布

为了生成你的首次发布的CHANGELOG，运行以下命令：

npm run release -- --first-release

这将会创建一个带有初始版本的tag，而不会增加版本号。

发布新版本

当你要发布一个新版本时，只需运行：

npm run release

如果需要发布预发布版本，可以添加--prerelease标志：

npm run release -- --prerelease

或者指定预发布名称：

npm run release -- --prerelease alpha

3. 应用案例和最佳实践

为了最大化利用standard-version，你应该遵循以下最佳实践：

• 确保所有的提交信息都遵循Conventional Commits格式。
• 在项目中设置正确的packageFiles和bumpFiles，以便正确地更新版本号和CHANGELOG。
• 使用versionrc文件来自定义版本控制的行为。

4. 典型生态项目

standard-version 是Conventional Changelog生态系统的一部分，以下是一些与之协同工作的典型项目：

• conventional-changelog-cli：生成项目CHANGELOG的命令行工具。
• release-please：GitHub Actions的自动化发布工具。

通过结合这些工具，可以创建一个高效、自动化的版本发布流程。

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