npm 包 @signalk/github-create-release 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，GitHub 是程序员们非常常用的版本控制工具，其提供了一个强大的平台来协作、测试和发布代码。当我们需要发布代码时，也常常需要创建一个新的 release，并将该 release 发布到 GitHub 上。但手动创建 release 并不是一件方便的事情，无论您是在本地或是 CI/CD 中，都可能遇到各种问题。在这种情况下，npm 包 @signalk/github-create-release 就可以派上用场了。

一、@signalk/github-create-release 是什么？

@signalk/github-create-release 是一个 npm 包，可以用于自动创建 GitHub Release。使用该 npm 包可以帮助我们快速、方便地在代码仓库中创建 release，并将代码发布到 GitHub 上。

这个 npm 包依赖于@octokit/rest 和 @octokit/auth-token，并且可以提供以下功能：

创建新 release，并将其发布到 GitHub 上
为 release 添加注释、资产、预发行版等
读取已经发布的 release

因此，我们可以使用该 npm 包，来优化发布过程，使其更加高效、准确。

二、如何安装和使用？

安装 @signalk/github-create-release 可以通过 npm 进行安装，运行以下命令：

npm install @signalk/github-create-release

可以在 github 上创建 access token 并将其授权给你的仓库，让它具备向仓库中添加 Release 权限。

GITHUB_TOKEN = xxxxxxxxxxxxxxxxxxxx

在 NodeJS 中使用该包可以根据以下代码进行操作：

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

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

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

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

三、参数列表

下面是 createRelease() 支持的参数列表:

token GitHub 访问令牌，用于授权您的 GitHub 账户的访问权限。
options.owner String — Git 仓库的所有者。
options.repo String — 仓库名称。
options.tag_name String — GitHub Release 标记名称。
options.name String — GitHub Release 名称。
options.body String — GitHub Release 的描述。
options.target_commitish String — 目标 Git 引用或提交 SHA。
options.draft Boolean — 如果设置为 true，则将此 Release 设置为草稿状态。
options.prerelease Boolean — 如果设置为 true，则将此 Release 标记为预发布版。
options.assets Array<file> — 包含要上传到 Release 的资产的数组。
options.release_id Number — 可选的，如果设置，则对该 Release 进行修改。

四、示例代码

以下是通过 createRelease() 方法创建 release 的示例代码：

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

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

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

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

此时在 GitHub 上会创建一个 draft 的，版本号为 v1.0.0 的 release。

五、总结

@signalk/github-create-release 使我们的发布流程更加自动化和高效。我们可以使用它，节省发布代码所花费的时间和精力。同时这个 npm 包也给我们提供了可以使用的 API，例如获取已发布的 Release 等。当您使用 GitHub 时，值得一试。

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