GitLab CI
你的流水线保留在 GitLab 中。Tuist 为每个作业提供一台隔离的 Linux 或 macOS 机器,并将日志和结果报告给 GitLab 和 Tuist 仪表板。需要 GitLab 19.3 或更高版本。支持通过公共 HTTPS 访问的 GitLab.com 和自托管实例。
-
创建 GitLab Runner。 在项目的Settings → CI/CD → Runners中,创建一个项目级 Runner。你也可以使用群组级 Runner。将所有你想使用的 Tuist 配置文件标签添加为 Runner 标签,例如
tuist-linux和tuist-macos,并禁用Run untagged jobs。保留 GitLab 显示的身份验证令牌,该令牌以glrt-开头。你无需在自己的机器上安装 Runner。 -
在 Tuist 中连接一次。 在Settings → Integrations中,选择 GitLab CI 卡片上的Connect。输入你的 GitLab URL 和 Runner 身份验证令牌。该连接可以为使用不同配置文件的作业提供服务。令牌以加密方式存储,且不会再显示。可选地,添加一个 API 访问令牌,以便合并请求流水线可以保存缓存卷;请参阅Merge request pipelines。
-
在每个作业中选择机器。 在作业的
tags中设置恰好一个Tuist 配置文件标签。允许其他标签,前提是注册的 GitLab Runner 也拥有这些标签:# .gitlab-ci.yml linux-check: tags: [tuist-linux] script: - uname -a test: tags: [tuist-macos] script: - tuist test retry: max: 2 when: runner_system_failureyaml# .gitlab-ci.ymllinux-check:tags: [tuist-linux]script:- uname -atest:tags: [tuist-macos]script:- tuist testretry:max: 2when: runner_system_failure -
推送并观察。 Tuist 会在一分钟内开始轮询。作业将出现在Runners下,并提供指向 GitLab 作业、日志和机器指标的链接。GitLab 在作业运行时接收日志;Tuist 在作业结束时接收脱敏后的日志。
Tuist 从每个分配中读取CI_JOB_TAGS,并在已连接的 Tuist 账户内解析配置文件。它不会从CI_RUNNER_TAGS推断机器,也不会使用默认配置文件。缺少、未知或多个 Tuist 配置文件标签会导致获取的作业失败,并在其 GitLab 日志中提供解释。不要在你的流水线变量中覆盖CI_JOB_TAGS。
执行环境#
作业在隔离的机器内使用 GitLab 的shell executor。检出、CI 变量、before_script、script、after_script、产物和取消操作由 GitLab Runner 处理。流水线的image:和services:设置不会配置此 shell 环境;请使用安装在runner image上的工具,或在脚本中安装它们。
可复用的 Runner 身份验证令牌保留在 Tuist 服务器上。机器仅接收其分配作业所需的凭据。目前,GitLab 作业暂不提供缓存签名授权。自定义 Linux 缓存卷通过 GitLab 的 API 验证作业身份并保存权限;可覆盖的 CI 变量无法建立信任。
一旦 Tuist 获取作业,GitLab 就会将其标记为运行中,并开始计时超时。当 Tuist 已获取的作业占用了你账户的并发限制时,后续作业将在 GitLab 中保持挂起状态。已获取的作业等待机器的时间最长为其作业超时时间,最多 12 小时。如果届时没有可用机器,Tuist 将使该分配失败并返回runner_system_failure,上述重试策略允许 GitLab 重试该作业。同样的策略也适用于丢失的 Runner 机器。
轮换令牌和断开连接#
更新连接的令牌并选择Save changes以进行轮换。将令牌留空可保留现有凭据。
Disconnect会停止获取并使等待中的分配失败。正在运行的作业继续使用其自身的凭据。如果无法访问 GitLab,Tuist 会在重试取消等待中的分配的同时保留已禁用的连接。一旦这些分配处理完毕,连接将被移除。
缓存卷#
使用cache volumes在作业之间保留 Xcode、模块和 Gradle 缓存以及其他目录。在检出之后、在使用它们的命令之前添加它们。
合并请求流水线#
项目的推送、计划和 Web 流水线会将其更改保存到缓存卷。合并请求流水线会使用缓存,但仅当连接具有 API 访问令牌时才会保存其更改:
- 在 GitLab 中,创建一个具有Reporter角色和
read_api范围的项目或群组访问令牌。群组令牌涵盖在该群组中运行于 Tuist Runner 上的所有项目。 - 在Settings → Integrations中,将其粘贴到 GitLab CI 卡片上的API access token中,并选择Save changes。
随后,Tuist 会读取每个合并请求流水线对应的合并请求。从项目自身分支发起的合并请求流水线会将其更改保存在该合并请求的源分支下,因此 Runner 配置文件的branch settings适用于该分支。来自 Fork 的合并请求永远不会保存。如果 Tuist 无法读取合并请求,作业仍会运行并使用缓存,但其更改会被丢弃。