語言› Node.js

在 Node.js 中使用 Buddy 進行 CI/CD

使用加密的 .env.vault 檔案在 Buddy 中執行 Node.js CI/CD

初始設定

建立一個 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

當您在記錄中看到 '從加密的 .env.vault 載入環境' 時，您會知道一切都正常運作。如果未設定 DOTENV_KEY (例如在本機機器上開發時)，它會回復為標準的 dotenv 功能。

您已成功使用新的 .env.vault 標準來加密和部署您的機密。這比將您的機密分散在多個第三方平台和工具上安全得多。每當您需要新增或變更機密時，只需重建您的 .env.vault 檔案並重新部署即可。