npm 包 release-it 使用教程

阅读时长 4 分钟读完

在前端开发中,我们通常需要发布自己开发的 npm 包。而发布 npm 包是一个重要的工作,需要考虑版本管理、打包、发布等问题。在这里,我们介绍一个方便易用的 npm 包管理工具——release-it。

release-it 介绍

release-it 是一个专门用于管理 npm 包版本和发布的命令行工具。使用 release-it 可以方便地自动化版本控制、Git 提交、生成变更日志、打 tag 和发布到 npm registry 等操作。

安装 release-it

release-it 基于 Node.js 开发,因此需要先安装 Node.js。然后,可以通过 npm 安装 release-it:

配置 release-it

在使用 release-it 之前,需要先进行一些配置。首先,在项目根目录下创建一个 .env 文件,并添加以下内容:

其中,<Your GitHub token> 是你的 GitHub Token,用于访问 GitHub API。如果还没有创建 Token,可以参考 Creating a personal access token

然后,在项目根目录下创建一个 release-it.json 文件,并添加以下内容:

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

上述配置文件中,git 部分用于设置 Git 相关操作,github 部分用于设置 GitHub 相关操作,npm 部分用于设置 npm 相关操作。在这里,我们设置了标签名、提交信息、发布 release 和发布到 npm registry。

使用 release-it

在完成 release-it 的安装和配置之后,就可以使用它来管理项目的版本和发布了。下面是一些常用命令:

发布一个新版本

运行上述命令时,release-it 会自动检测当前项目的版本,并根据语义化版本规范增加版本号。然后,release-it 会进行 Git 提交、打 tag、生成变更日志、发布 release 和发布到 npm registry 等操作。最后,它会提示你是否需要将本地的变更推送到远程仓库。

指定要发布的版本号

如果你想手动指定要发布的版本号,可以使用 --release-as 参数,例如:

只生成变更日志

如果你只想生成变更日志,可以使用 --dry-run 参数,例如:

此时,release-it 不会进行 Git 提交、打 tag、发布 release 和发布到 npm registry 等操作,而只会生成变更日志。

自定义配置文件路径

如果你的配置文件不是在项目根目录下的 release-it.json 文件中,可以使用 --config 参数指定配置文件路径,例如:

总结

本文介绍了如何使用 release-it 进行 npm 包版本管理和发布。通过 release-it,我们可以方便地自动化版本控制、Git 提交、生成变更日志、打 tag 和发布到 npm registry 等操作,提高了开发效率。

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

纠错
反馈