框架 › Remix.js

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

使用加密的 .env.vault 文件在 GitHub Actions 中运行 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 加载器包含 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 文件并重新部署即可。