语言 › Node.js

使用 Buddy 的 Node.js 中的 CI/CD

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

创建一个 buddy.yml 文件。

buddy.yml

- pipeline: "Build"
  on: "EVENT"
  events:
  - type: "PUSH"
  resources: "DEFAULT"
  actions:
  - action: "build"
    type: "BUILD"
    docker_image_name: "library/node"
    docker_image_tag: "16"
    execute_commands:
      - npm install
      - npm run build

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

buddy.works/org/app/pipelines

推送后，Buddy 管道构建将显示“'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

在 Buddy 上设置 DOTENV_KEY。

buddy.works

构建 CI

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

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

buddy.works

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

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