程式語言› Node.js

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

在 CircleCI 中使用加密的 .env.vault 檔案執行 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"
  }
}

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

它會顯示 Hello ci。

app.circleci.com 建置

當您在記錄中看到 'Loading env from encrypted .env.vault' 時，表示一切運作正常。如果未設定 DOTENV_KEY（例如在您的本機電腦上開發時），它會回退到標準的 dotenv 功能。

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