Turborepo logo

远程缓存

Turborepo 的任务缓存通过避免重复工作来节省时间。

但存在一个问题:缓存是本地机器的。当您使用持续集成系统时,这可能会导致大量重复工作

Local caching creates a cache on each system.

由于 Turborepo 默认仅缓存到本地文件系统,因此即使所有任务输入都相同,也必须在每台机器上重新执行相同的任务 (turbo run build)——这会浪费时间和资源

须知: 

您不必使用远程缓存才能使用 Turborepo。虽然远程缓存会带来最显著的速度提升,但即使不使用远程缓存,您也可以加快现有工作流程。

单一共享缓存

如果可以在整个团队(甚至包括 CI)中共享一个 Turborepo 缓存会怎么样?

Remote caching creates a shared cache for your entire team.

Turborepo 可以安全地与远程缓存(一个存储任务结果的云服务器)通信。这可以通过防止整个组织内的重复工作来节省大量时间。

远程缓存是免费的,可以与托管提供商自托管缓存一起使用。

远程缓存是 Turborepo 的一项强大功能,但能力越大,责任越大。请确保首先正确缓存,并仔细检查环境变量的处理。另请记住,Turborepo 将日志视为工件,因此请注意您在控制台中打印的内容。

Vercel

Vercel 远程缓存在所有计划中均可免费使用,即使您不在 Vercel 上托管应用程序也是如此。按照以下步骤为您的仓库启用远程缓存。

本地开发

要将本地 Turborepo 链接到远程缓存,请使用您的 Vercel 帐户验证 Turborepo CLI

终端
turbo login

如果您没有全局 turbo 安装,您也可以使用您的包管理器

终端
npx turbo login

如果您的远程缓存配置为使用单点登录,您将需要运行 npx turbo login --sso-team=team-name 以获取具有正确权限的缓存令牌。

现在,将您的 Turborepo 链接到您的远程缓存

终端
turbo link

启用后,对当前正在缓存的包进行一些更改,并使用 turbo run 对其运行任务。您的缓存工件现在将本地远程缓存中存储。

要验证,请使用以下命令删除本地 Turborepo 缓存

终端
rm -rf ./.turbo/cache

然后,再次运行相同的构建。如果一切正常,turbo 应该不会在本地执行任务。相反,它将从远程缓存下载日志和工件,并将它们重放给您。

Vercel 上的远程缓存

如果您在 Vercel 上构建和托管您的应用程序,一旦您使用 turbo,远程缓存将自动为您设置。有关更多信息,请参阅Vercel 文档

工件完整性和真实性验证

Turborepo 可以在将工件上传到远程缓存之前使用密钥对其进行签名。Turborepo 在工件上使用 HMAC-SHA256 签名,使用您提供的密钥。当下载远程缓存工件时,Turborepo 将验证其完整性和真实性。任何未能通过验证的工件都将被 Turborepo 忽略并视为缓存未命中。

要启用此功能,请在您的 turbo.json 配置中设置 remoteCache 选项以包含 signature: true。然后通过声明 TURBO_REMOTE_CACHE_SIGNATURE_KEY 环境变量来指定您的密钥。

./turbo.json
{
  "remoteCache": {
    "signature": true
  }
}

远程缓存 API

远程缓存可以由任何符合 Turborepo 远程缓存 API 规范的 HTTP 服务器实现。

Vercel 托管的远程缓存

Turborepo 的创建者和维护者 Vercel 提供了一个托管的远程缓存,它与 Turborepo 完全兼容。

使用 Vercel 远程缓存是零配置的,并通过开源 Vercel 远程缓存 SDK 自动与 Vercel 部署集成。

了解有关 Vercel 上的 Turborepo 的更多信息,或免费部署模板来试用它。

自托管

您还可以自托管您自己的远程缓存,并使用 --manual 标志登录到它以提供 API URL、团队和令牌信息。

终端
turbo login --manual

OpenAPI 规范

您可以在此处找到 API 的 OpenAPI 规范。目前,所有版本的 turbo 都与 v8 端点兼容。

社区实现

Turborepo 社区已经创建了远程缓存的开源实现。

小时

总计算时间节省
开始使用
远程缓存 →

本页目录