Node.js 中使用 Gitlab CI 的 CI/CD
在 Gitlab CI 中使用加密的 .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"
}
}
建立一個 .gitlab-ci.yml 檔案。
.gitlab-ci.yml
image: node:20.5
build:
stage: build
script:
- npm install
- npm run build
將其提交到程式碼並推送到 Gitlab。
推送後，Gitlab CI 建置將會顯示 '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 為每個環境設定這些機密。
然後建立您加密的 .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
在 Gitlab 上設定 DOTENV_KEY。
建立 CI
將這些變更安全地提交到程式碼中，然後重新執行建置。
就是這樣！在重新執行時，您的 .env.vault 檔案將會被解密，並且它的 CI 機密將會被注入為環境變數 – 正好及時。
當您在記錄中看到 'Loading env from encrypted .env.vault' 時，您就會知道一切都運作正常。如果沒有設定 DOTENV_KEY （例如，在您的本機電腦上開發時），它將會回退到標準的 dotenv 功能。
您已成功使用新的 .env.vault 標準來加密和部署您的機密。這比將您的機密分散在多個第三方平台和工具上要安全得多。每當您需要新增或變更機密時，只需重建您的 .env.vault 檔案並重新部署即可。