npm包:grunt-github-releaser2 使用教程

阅读时长 4 分钟读完

简介

grunt-github-releaser2 是一个用于快速发布 GitHub 仓库的新版本的 Grunt 插件。它可以帮助开发者在发布新版本时,自动创建 GitHub 的 release 页面,并将新版本的发布附件一同打包上传到 release 中。该插件使用起来方便简单,只需要在 Grunt 的配置文件中进行配置就可以实现自动发布。

安装

安装 grunt-github-releaser2 非常简单,只需要在命令行中输入以下命令即可:

配置

在 Grunt 的配置文件中进行以下配置:

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

其中,以下是常用的配置项:

  • authToken(必填):GitHub 授权令牌。
  • tagName:GitHub 上将要创建的 tag 名称。如果不填写,则使用 package.json 中的 version 字段。
  • name:GitHub release 名称。如果不填写,则使用 package.json 中的 nameversion 字段拼接而成。
  • notes:GitHub release 的描述信息。
  • owner:GitHub 仓库所属用户名称。
  • repo:GitHub 仓库名称。
  • assets:将会被一同打包上传的文件地址,可以使用文件拓展名匹配符号。例如,./*.{zip,tar.gz} 表示将所有 .zip.tar.gz 格式的文件上传。

使用

在 Grunt 命令行中输入以下命令进行使用:

此时,经过配置的 Grunt 插件就会自动将 GitHub 上的 release 页面创建完成,同步上传新版本的发布附件。

示例代码

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

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

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

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

--

总结

通过使用 grunt-github-releaser2,我们可以更加方便快捷地进行 GitHub 仓库版本的发布,提升项目的发布效率;同时,在配置过程中,我们也需要注意 GitHub 的授权信息,防止出现无法授权错误。

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

纠错
反馈