npm 包 github-build 使用教程

简介

github-build 是一个 Node.js 的 npm 包,它可以帮助我们更方便地在 GitHub 上构建和发布我们的项目。

安装

在终端中输入以下命令来安装 github-build

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

使用

步骤 1:创建配置文件

在你的项目根目录下创建一个名为 .github-build.yml 的文件,这是 github-build 的配置文件。该文件的格式如下:

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

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

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

在上面的示例中,我们定义了两个步骤:buildrelease。在 build 步骤中,我们执行了 npm cinpm run build 命令来构建我们的应用程序。在 release 步骤中,我们执行了两个命令:创建一个版本标签,并将代码推送到 GitHub;以及发布到 npm。

注意,我们使用了 ${{ env.VERSION }} 来代表当前版本号。这是一个环境变量,我们需要在后续步骤中定义它。

步骤 2:配置 GitHub Actions

在你的项目根目录下创建一个名为 .github/workflows/build.yml 的文件,这是 GitHub Actions 的配置文件。该文件的格式如下:

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

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

在上面的示例中,我们定义了一个作业 build,它会在推送到 main 分支时运行。在 build 作业中,我们执行了以下步骤:

  1. 使用 actions/checkout 动作来检出代码。
  2. 使用 actions/setup-node 动作来设置 Node.js 环境。
  3. 执行 npm ci 命令安装依赖。
  4. 使用 echo "::set-env name=VERSION::$(npm version patch)" 命令来设置环境变量 ${{ env.VERSION }} 的值,该命令会自动将版本号加上一个修订号。
  5. 使用 shogo82148/actions-github-build@v1.1.0 动作来运行 github-build

最后,我们需要在 GitHub 仓库的“Settings”页面中配置两个 secrets:GITHUB_TOKENNPM_TOKEN。这些 secrets 将用于进行 GitHub 和 npm 的身份验证。

步骤 3:构建和发布项目

现在我们可以开始构建和发布我们的项目了。只需要执行以下命令:

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

当我们将代码推送到 GitHub 时,GitHub Actions 将自动运行 build.yml 文件中定义的作业。如果一切顺利,我们的应用程序将被构建并发布到 npm。

结论

使用 github-build 可以帮助我们更轻松地构建

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/47454


猜你喜欢

  • npm 包 helper-license 使用教程

    在前端开发中,我们经常会使用到许多第三方的 npm 包。然而,在使用这些包时,我们也需要遵守相应的许可证规定。helper-license 是一个非常实用的 npm 包,可以帮助我们快速查看和解析各种...

    6 年前
  • npm 包 try-open 使用教程

    简介 在前端开发中,我们经常需要打开外部链接或本地文件。try-open 是一个可以帮助我们快速打开链接或文件的 npm 包。它能够根据不同的操作系统和环境,自动选择最适合的方式来打开链接或文件。

    6 年前
  • npm 包 helper-coverage 使用教程

    npm 包 helper-coverage 是一款前端项目中用于计算代码覆盖率的工具,能够帮助开发者更好地了解项目的测试情况和代码质量。本文将详细介绍如何使用该工具。

    6 年前
  • ESLint 插件 - xo 使用教程

    简介 eslint-plugin-xo 是一个基于 XO 的 ESLint 插件,它提供了一套严格的 JavaScript 代码规范,并帮助你在项目中强制执行这些规范。

    6 年前
  • npm 包 arr-unique 使用教程

    什么是 arr-unique? arr-unique 是一个基于 JavaScript 的 npm 模块,用于去除数组中的重复元素。它可以应用于任何 JavaScript 环境,并且经过了广泛的测试和...

    6 年前
  • npm 包 stringify-keys 使用教程

    在前端开发中,我们常常需要将 JavaScript 对象转换成 JSON 格式数据进行传输和存储。但是,在使用 JSON.stringify() 方法时,我们经常会遇到一些问题,例如对象属性名含有特殊...

    6 年前
  • npm 包 glob-object 使用教程

    什么是 glob-object? glob-object 是一款用于匹配文件路径的 npm 包,它可以使用类似于 glob 的模式来过滤和匹配文件路径,并将匹配到的路径转换为一个对象。

    6 年前
  • npm包filter-object使用教程

    介绍 filter-object是一个基于JavaScript的npm包,用于过滤对象中不需要的属性。它提供了方便且简单的方法来移除对象中不必要的键值对,同时保留有用的数据。

    6 年前
  • npm 包 code-context 使用教程

    在前端开发中,代码调试是非常重要的一项工作。npm 包 code-context 可以帮助你快速查找和定位代码中的错误和异常,提高开发效率。本文将介绍如何使用 code-context。

    6 年前
  • npm 包 api-toc 使用教程

    在开发前端应用程序时,API 文档是必不可少的。然而,随着 API 文档内容的增加,很容易失去对整个文档的概览和结构的掌控。这时候,一个自动生成目录的工具将会显得尤为重要。

    6 年前
  • npm 包 helper-codelinks 使用教程

    前言 在前端开发中,我们经常需要引用其他 npm 包中的函数、类等资源。通常情况下,我们会使用相对路径或绝对路径来引用它们。但是这样做存在一个问题,当我们在修改目录结构时,可能需要频繁地修改相关代码。

    6 年前
  • npm 包 js-comments-template 使用教程

    简介 js-comments-template 是一款基于 Node.js 的 npm 包,能够根据 JavaScript 代码中的注释生成文档或者模板。 这个包可以在前端项目中使用,方便开发者快速生...

    6 年前
  • npm包arr-map使用教程

    在前端开发中,我们经常需要对数组进行操作和转换。如果能够有一个方便、高效的工具来完成这些操作,就能提高我们的开发效率和代码质量。而npm包arr-map就是这样一款工具,它能够帮助我们快速地处理数组数...

    6 年前
  • npm 包 map-files 使用教程

    简介 map-files 是一个 Node.js 的 npm 包,它提供了一个简便的方法来遍历文件夹中的所有文件,并通过回调函数对每个文件进行处理。在前端开发中,我们经常需要遍历静态资源文件夹,比如图...

    6 年前
  • NPM 包 file-reader 使用教程

    在前端开发中,我们经常需要读取本地文件以及将其上传到服务器。为了简化这个过程,可以使用 npm 包 file-reader。本文将详细介绍如何使用该包,并提供示例代码。

    6 年前
  • npm 包 to-exports 使用教程

    to-exports 是一个 NPM 包,它可以将 JavaScript 模块的导出方式从 CommonJS 转换为 ES6 模块。本文将介绍 to-exports 的使用方法,包括安装、配置和示例。

    6 年前
  • npm 包 js-comments 使用教程

    js-comments 是一个开源的 npm 包,可以帮助前端开发者在代码中添加注释、生成文档和测试用例,提高代码可读性和可维护性。本文将详细介绍如何使用 js-comments。

    6 年前
  • npm 包 is-true 使用教程

    什么是 is-true? is-true 是一个轻量级的 npm 包,用于判断给定值是否为 true。它可以在浏览器端和 Node.js 环境中使用。 如何安装 is-true? 使用 npm 安装 ...

    6 年前
  • npm 包 is-plain-object 使用教程

    在开发前端应用程序时,我们通常需要使用对象来存储和处理数据。但是,在某些情况下我们需要检查对象是否只包含简单的键值对,而不是继承自原型或其它特殊属性。这时,我们可以使用 npm 包 is-plain-...

    6 年前
  • npm 包 init-file-loader 使用教程

    有时,在前端项目中,我们需要使用一些静态文件(如图片、音频、视频等)作为应用程序的一部分。通常情况下,我们可以通过直接将这些文件放置在项目的某个目录下来实现这一点。

    6 年前

相关推荐

    暂无文章