语言 › Node.js

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

使用加密的 .env.vault 文件在 CircleCI 中运行 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"
  }
}

创建一个 .circleci/config.yml 文件。

.circleci/config.yml

# .circleci/config.yml
version: 2.1
orbs:
  node: circleci/[email protected]
jobs:
  build:
    docker:
      - image: cimg/base:2021.04
    steps:
      - checkout
      - node/install
      - node/install-packages
      - run:
          name: Run build
          command: npm run build

运行 npm install 以包含 package-lock.json 文件。

npm install

将所有内容提交到代码并推送到 GitHub。然后将你的 GitHub 仓库连接到 CircleCI。

app.circleci.com

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

安装 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

在 CircleCI 上设置 DOTENV_KEY。

app.circleci.com

构建 CI

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

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

app.circleci.com build

它将显示 Hello ci。

app.circleci.com build

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

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