npm 包 github-build 使用教程

阅读时长 4 分钟读完

简介

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

纠错
反馈