在 CircleCI 上集成

以下示例展示了如何将 Turborepo 与 CircleCI 一起使用。

CircleCI 上的 TTY

CircleCI 使用交互式终端 (TTY) 这会导致 Turborepo 的终端 UI 崩溃。为了解决这个问题,在你的 CircleCI 配置中设置 TURBO_UI=false 环境变量。

对于给定的根 package.json

./package.json
{
  "name": "my-turborepo",
  "scripts": {
    "build": "turbo run build",
    "test": "turbo run test"
  },
  "devDependencies": {
    "turbo": "latest"
  }
}

以及一个 turbo.json

Turborepo logo
./turbo.json
{
  "$schema": "https://turbo.build/schema.json",
  "tasks": {
    "build": {
      "outputs": [".next/**", "!.next/cache/**"],
      "dependsOn": ["^build"]
    },
    "test": {
      "dependsOn": ["^build"]
    }
  }
}

在你的仓库中创建一个名为 .circleci/config.yml 的文件,内容如下:

.circleci/config.yml
version: 2.1
orbs:
  node: circleci/node@5.0.2
workflows:
  test:
    jobs:
      - test
jobs:
  test:
    docker:
      - image: cimg/node:lts
    steps:
      - checkout
      - node/install-packages
      - run:
        command: npm run build
        environment:
          TURBO_UI: "false"
 
      - run:
        command: npm run test
        environment:
          TURBO_UI: "false"

远程缓存

要使用远程缓存,请获取你的提供商的远程缓存的团队和令牌。在此示例中,我们将使用 Vercel 远程缓存

  • TURBO_TOKEN - 访问远程缓存的 Bearer 令牌
  • TURBO_TEAM - 单体仓库所属的账户

要使用 Vercel 远程缓存,你可以通过以下步骤获取这些变量的值:

  1. Vercel 控制面板 中为你的账户创建一个范围访问令牌

Vercel 访问令牌

将值复制到安全的地方。你稍后会需要它。

  1. 转到你的 CircleCI 项目设置,点击 Environment Variables 标签。创建一个名为 TURBO_TOKEN 的新密钥,并输入你的范围访问令牌的值。

CircleCI 环境变量 CircleCI 创建环境变量

  1. 创建第二个名为 TURBO_TEAM 的密钥,并输入你的团队的 Vercel URL 值,不带 vercel.com/。你可以在控制面板的团队通用项目设置中找到你的团队 URL。

    如果你使用的是业余计划,可以使用你的用户名。你可以在 Vercel 个人账户设置 中找到你的用户名

Vercel 账户标识

  1. CircleCI 会自动将项目设置中存储的环境变量加载到 CI 环境中。CI 文件不需要任何修改。