npm 包 new-release 使用教程

阅读时长 3 分钟读完

在前端开发中,我们经常会使用 npm 来管理项目所依赖的包。而当我们需要发布自己的 npm 包时,就需要用到一些工具来辅助我们进行版本管理、发布等操作。其中一个比较好用的工具就是 new-release。

什么是 new-release?

new-release 是一个命令行工具,可以帮助我们生成 changelog、自动更新版本号、打标签、发布到 npm 等操作,从而简化了发布新版本的流程。

如何使用 new-release?

以下是使用 new-release 发布新版本的步骤:

1. 安装

首先,我们需要全局安装 new-release:

2. 初始化配置文件

接着,我们需要在项目根目录下创建一个名为 .releaserc.json 的配置文件,并填写配置项。以下是一个示例配置:

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

其中,githubnpm 分别指定了 github 和 npm 相关的配置项。github.release 表示是否需要在 github 上发布 release,github.usernamegithub.repo 分别表示 github 账号名和仓库名。npm.publish 表示是否需要将包发布到 npm 上。

更多配置项详见官方文档:https://github.com/akameco/new-release#config

3. 运行 new-release 命令

当我们准备发布新版本时,只需要在项目目录下运行以下命令即可:

该命令会自动完成以下操作:

  • 根据 commit message 自动生成 changelog
  • 自动更新 package.json 中的版本号
  • 打 tag
  • 发布到 npm
  • (可选)发布 release 到 github

4. 配置 commit message

为了让 new-release 能够正确生成 changelog,我们需要在 git commit 时按照一定格式填写 commit message。具体格式详见官方文档:https://github.com/akameco/new-release#commit-message-format

以下是一个示例 commit message:

其中,feat 表示这是一个新增功能的 commit。

总结

通过使用 new-release 工具,我们可以更快速地管理和发布自己的 npm 包。除此之外,良好的 commit message 规范也是十分重要的。希望本文对大家有所帮助!

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

纠错
反馈