npm 包 start-release 使用教程

前言

在前端开发过程中，我们经常需要发布各种版本的代码，包括正式版和测试版等。手动发布这些版本非常麻烦，我们需要进行打包、修改版本号、发布到指定的仓库等步骤。

start-release 是一个 npm 包，特别为这类问题而准备的，它可以帮助我们自动完成版本升级、git 提交、打 tag、发布到 npm registry 等步骤。本文将详细介绍 start-release 的使用方法，以及如何在项目中使用它。

安装

在安装 start-release 前，我们需要先全局安装 commitizen 和 conventional-changelog-cli 这两个工具。它们是 start-release 的依赖项，可以帮助我们在提交时使用标准的 commit message，以及自动生成 changelog。

npm install -g commitizen conventional-changelog-cli
npm install start-release --save-dev

使用

在我们的项目根目录下，输入以下命令：

npm run release

程序将自动完成以下工作：

• 检查 git 是否有未提交的变更；
• 通过 commitizen 生成标准的 commit message；
• 根据 commit message 自动升级版本号；
• git 提交变更、打 tag；
• 生成 changelog；
• 发布到 npm registry。

在运行过程中，start-release 会提示我们输入一些选项，例如版本号、发布类型等。我们可以根据需要进行调整。

配置

start-release 非常灵活，我们可以通过配置文件进行自定义。在项目根目录下，创建 .releaserc 文件（YAML 格式），定义一些选项。

以下是一个简单的例子：

tagPrefix: "v"
infile: "CHANGELOG.md"
firstRelease: false

• tagPrefix：tag 前缀，默认为无；
• infile：changelog 文件路径，默认为 CHANGELOG.md；
• firstRelease：是否为第一次发布，默认为 false，表示不是第一次发布。

我们可以参考 start-release 的文档，自由定制 .releaserc 文件中的选项。

示例

以下是一个实际使用 start-release 的示例。

1. 克隆 git 项目。

   git clone https://github.com/facebook/react.git

2. 安装 npm 包。

   cd react
   npm install
   npm install start-release --save-dev

3. 运行 start-release。

   npm run release

   在运行过程中，start-release 会提示我们输入一些选项。例如，指定版本号、选择发布类型等。

4. 当发布成功后，我们可以在 npm 上查看发布的包。

   npm view react

   注意，在发布前，我们需要先在 npmjs.org 注册一个账户，并登录到 npm 客户端。

结语

start-release 是一个非常实用的 npm 包，可以帮助我们完成版本升级、git 提交、打 tag、发布到 npm registry 等繁琐的任务。它的使用方法非常简单，只需要输入一个命令即可。

当然，start-release 还有很多其他的功能，例如指定发布仓库、使用自定义版本规则等，可以根据自己的需求进行设置。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005598c81e8991b448d723a