语言 › Node.js

使用 GitHub Actions 在 Node.js 中进行 CI/CD

使用加密的 .env.vault 文件在 GitHub Actions 中运行 Node.js CI/CD

在本指南中找到一个完整的GitHub 上的代码示例。

初始设置

创建一个 build.js 文件。这是一个非常简单的构建脚本，它输出 'Hello World'。

build.js

// build.js
console.log(`Hello ${process.env.HELLO}`)

创建一个 package.json 文件。

package.json

{
  "scripts": {
    "build": "node build.js"
  }
}

创建一个 .github/workflows/ci.yml 文件。

.github/workflows/ci.yml

name: npm run build
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: actions/setup-node@v3
      with:
        node-version: 16
    - run: npm install
    - run: npm run build
      env:
        DOTENV_KEY: ${{ secrets.DOTENV_KEY }}

将这些提交到代码并推送到 GitHub。

推送后，GitHub Actions 构建将显示 'Hello undefined'，因为它还没有办法访问环境变量。我们接下来将解决这个问题。

github.com/you/app/actions

安装 dotenv

安装dotenv。

npm install dotenv --save # Requires dotenv >= 16.1.0

在项目的根目录下创建一个 .env 文件。

.env

# .env
HELLO="World"

尽早导入和配置 dotenv。

build.js

// build.js
require('dotenv').config()
console.log(process.env) // remove this after you've confirmed it is working

console.log(`Hello ${process.env.HELLO}`)

尝试在本地运行它。

node build.js
{
  ...
  HELLO: 'World'
}
Hello World

完美。process.env 现在拥有您在 .env 文件中定义的键和值。

这涵盖了 CI 的本地模拟。接下来，让我们解决真正的 CI 环境问题。

构建 .env.vault

推送您最新的 .env 文件更改并编辑您的 CI 密钥。了解有关同步的更多信息

npx dotenv-vault@latest push
npx dotenv-vault@latest open ci

使用 UI 为每个环境配置这些密钥。

dotenv.org

然后构建您的加密 .env.vault 文件。

npx dotenv-vault@latest build

它的内容应该类似于此。

.env.vault

#/-------------------.env.vault---------------------/
#/         cloud-agnostic vaulting standard         /
#/   [how it works](https://dotenv.org/env-vault)   /
#/--------------------------------------------------/

# development
DOTENV_VAULT_DEVELOPMENT="/HqNgQWsf6Oh6XB9pI/CGkdgCe6d4/vWZHgP50RRoDTzkzPQk/xOaQs="
DOTENV_VAULT_DEVELOPMENT_VERSION=2

# ci
DOTENV_VAULT_CI="x26PuIKQ/xZ5eKrYomKngM+dO/9v1vxhwslE/zjHdg3l+H6q6PheB5GVDVIbZg=="
DOTENV_VAULT_CI_VERSION=2

设置 DOTENV_KEY

获取您的 CI DOTENV_KEY。

npx dotenv-vault@latest keys ci
# outputs: dotenv://:[email protected]/vault/.env.vault?environment=ci

在 GitHub Actions 上设置 DOTENV_KEY。

构建 CI

将这些更改安全地提交到代码并重新运行构建。

就是这样！重新运行后，您的 .env.vault 文件将被解密，其 CI 密钥将被注入为环境变量 - 恰逢其时。

当您在日志中看到 '从加密的 .env.vault 加载 env' 时，您将知道一切正常。如果没有设置 DOTENV_KEY（例如，在本地机器上开发时），它将回退到标准的dotenv 功能。

github actions 构建

您成功使用了新的 .env.vault 标准来加密和部署您的密钥。这比将密钥散布在多个第三方平台和工具中要安全得多。无论何时需要添加或更改密钥，只需重新构建 .env.vault 文件并重新部署。