跳转到内容

安装 Gradle 插件

Tuist 提供了一个 Gradle 插件,可与您的 Gradle 项目集成,以启用 远程构建缓存构建洞察 等功能。本指南将引导您完成插件的安装和配置。

在您的 Gradle 项目根目录运行以下命令:

Terminal window
mise x tuist@latest -- tuist init
Terminal window
tuist init

该命令将引导您完成身份验证、创建或选择 Tuist 项目,以及为 Gradle 项目生成配置。

运行 tuist init 后,您需要按照命令输出的说明,将 Tuist 插件添加到您的 settings.gradle.kts 中:

plugins {
id("dev.tuist") version "0.1.0"
}

虽然 tuist init 会在本地为您进行身份验证,但您的团队成员和 CI 环境需要单独进行身份验证。

每个团队成员应运行以下命令以在其机器上访问 Tuist 功能:

Terminal window
tuist auth login

对于 CI,请按照 CI 身份验证指南 为您的环境配置身份验证。

以下选项可在 settings.gradle.kts 中的 tuist 扩展块中使用:

选项类型默认值描述
projectString?null (可选)account/project 格式表示的项目标识符。如果未设置,插件会通过 Tuist CLI 从 tuist.toml 中读取。
executablePathString?null (使用 PATH 中的 tuist)Tuist CLI 可执行文件的路径。
urlString?nullTuist 服务器的基础 URL。如果未设置,默认为 "https://tuist.dev"tuist.toml 中定义的值。
uploadInBackgroundBoolean?null是否在后台上传构建和测试洞察。当 null(默认)时,本地构建在后台上传,CI 在前台上传。

安装并配置插件后,您可以启用以下功能:

  • 远程构建缓存 以在团队和 CI 之间共享构建产物。
  • 构建洞察 以在 Tuist 仪表板中跟踪任务计时和缓存行为。
  • 测试洞察 以跟踪测试性能并检测不稳定的测试。
  • 不稳定的测试 以自动检测、跟踪和隔离不稳定的测试。