npm 包 release-script 使用教程

阅读时长 4 分钟读完

简介

npm 是一个广泛使用的 JavaScript 包管理器,使得开发者可以方便地共享、发布和安装各种 JavaScript 库。在发布一个 npm 包时,我们需要手动执行一系列操作:如打 tag、更新 changelog、更新版本号等。这些操作虽然不难,但是非常繁琐,容易出错,而 release-script 就是为了解决这些问题而生。

release-script 是一款自动化发布 npm 包的命令行工具,能够快速、准确地执行一系列发布流程,并且支持定制化配置。本文将详细介绍 release-script 的使用方法,帮助开发者轻松完成 npm 包的发布。

安装

全局安装 release-script:

使用

初始化

在项目根目录下,执行以下命令来初始化 release-script 的配置文件:

执行完之后,会在项目根目录下生成 .releaserc.js 配置文件。该文件包含了 release-script 的所有配置项,默认配置如下:

-- -------------------- ---- -------
-------------- - -
  ---------- ----- -- ---- ---------
  ------- ----- -- --------
  ----- ----- -- -------------
  ---- ----- -- --- ---
  -------- ------------------- -- ------------------------------- --------
  -------------- ------- -- ----
  ------- --- -- ----------
-

配置项说明

changelog

是否更新 changelog 文件,如果为 true,则会自动在 CHANGELOG.md 中添加本次发布的版本记录。默认为 true。

commit

是否自动提交代码,如果为 true,则会自动将修改后的文件提交到 git 仓库。默认为 true。

push

是否自动推送代码到远程仓库,如果为 true,则会自动将本地分支推送到远程仓库。默认为 true。

tag

是否打 tag,如果为 true,则会自动在代码库中打上对应版本号的 tag。默认为 true。

version

版本号生成规则,可选值:'standard-version', 'semver'。如果选择 standard-version,则会使用 standard-version 生成版本号;如果选择 semver,则会根据当前版本号自动生成下一个版本号。默认为 standard-version

releaseBranch

发布分支,即在哪个分支上进行发布。默认为 main

script

发布前需要执行的脚本,可以是任意合法的 Shell 命令。默认为空。

发布

在项目根目录下,执行以下命令来执行发布操作:

该命令会按照 .releaserc.js 中的配置项依次执行发布操作。如果其中某一步执行失败,则会中止发布操作,并提示出错信息。

示例代码

以下是一个示例的 .releaserc.js 配置文件:

-- -------------------- ---- -------
-------------- - -
  ---------- -----
  ------- -----
  ----- -----
  ---- -----
  -------- -------------------
  -------------- -------
  ------- ---
-

在命令行中执行以下命令来进行发布:

执行完之后,会自动完成以下操作:

  • 更新 CHANGELOG.md 文件
  • 提交修改后的文件到 git 仓库
  • 推送本地分支到远程仓库
  • 打上对应版本号的 tag

总结

使用 release-script 可以大大简化 npm 包的发布流程,避免手动操作出错的情况发生。同时,release-script 还支持丰富的配置项,可以

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/46338

纠错
反馈