語言 › Node.js

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

在 GitHub Actions 中使用加密的 .env.vault 檔案執行 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 機密將會作為環境變數注入 - 正好及時。

當您在記錄檔中看到 'Loading env from encrypted .env.vault' 時，您就知道事情已正確運作。如果未設定 DOTENV_KEY (例如在您的本地機器上開發時)，它會回復為標準的 dotenv 功能。

github actions 建置

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