文件
框架 › Remix.js

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

在 GitHub Actions 中使用加密的 .env.vault 檔案執行 Remix.js CI/CD

請在 GitHub 上尋找本指南的完整程式碼範例。

初始設定

建立 Remix.js 應用程式。

npx create-remix@latest

這將建立一些檔案。

ls -1
README.md
app/
build/
node_modules/
package-lock.json
package.json
public/
remix.config.js
remix.env.d.ts
tsconfig.json

編輯 app/routes/_index.tsx 以使用 Remix loader 包含 process.env.HELLO。

app/routes/_index.tsx

import type { V2_MetaFunction } from "@remix-run/node";
import { json } from "@remix-run/node";
import { useLoaderData } from "@remix-run/react";

export const meta: V2_MetaFunction = () => {
  return [
    { title: "New Remix App" },
    { name: "description", content: "Welcome to Remix!" },
  ];
};

export async function loader() {
  return json({
    ENV: {
      HELLO: process.env.HELLO, // HELLO="World" in .env file
    },
  });
}

export default function Index() {
  const data = useLoaderData()

  return (
    <div>
      Hello {data.ENV.HELLO}.
    </div>
  );
}

建立 .github/worksflows/ci.yml 檔案。

.github/workflows/ci.yml

# .github/workflow/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 .，因為它還沒有存取環境變數的方法。接下來我們來做這件事。

預先載入 dotenv

安裝 dotenv。

npm install dotenv --save # Requires dotenv >= 16.1.0

在專案的根目錄中建立 .env 檔案。

.env

# .env
HELLO="World"

使用 dotenv 預先載入 Remix.js 指令碼。這會在 Remix.js 之前注入環境變數。

package.json

"scripts": {
  "build": "node -r dotenv/config ./node_modules/.bin/remix build",
  "dev": "node -r dotenv/config ./node_modules/.bin/remix dev",
  "start": "node -r dotenv/config ./node_modules/.bin/remix-serve build",
},

嘗試在本地執行它。

npm run dev
# Visit https://127.0.0.1:3000

它將顯示「Hello World」。

太棒了！現在 process.env 具有您在 .env 檔案中定義的金鑰和值。

這涵蓋了 CI 的本地模擬。接下來我們來解決實際的 CI 環境。

建置 .env.vault

推送您最新的 .env 檔案變更並編輯您的 CI 機密。 深入了解同步

npx dotenv-vault@latest push
npx dotenv-vault@latest open ci

使用 UI 來設定 CI 環境機密。

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 檔案並重新部署即可。