持续集成 (CI)

若要在持续集成工作流中运行 Tuist 命令，你需要在 CI 环境中安装它。

身份验证是可选的，但如果你想使用服务器端功能（如缓存），则必须进行身份验证。

以下部分提供了在不同 CI 平台上执行此操作的示例。

示例#

GitHub Actions#

在GitHub Actions上，你可以使用OIDC 身份验证来实现安全且无需密钥的身份验证：

yaml

name: Build Application
on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main

permissions:
  id-token: write
  contents: read

jobs:
  build:
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v4
      - uses: jdx/mise-action@v2
      - run: tuist auth login
      - run: tuist setup cache

yaml

name: Build Application
on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main

permissions:
  id-token: write
  contents: read

jobs:
  build:
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v4
      - run: brew install --formula [email protected]
      - run: tuist auth login
      - run: tuist setup cache

yaml

name: Build Application
on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main

env:
  TUIST_TOKEN: ${{ secrets.TUIST_TOKEN }}

jobs:
  build:
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v4
      - uses: jdx/mise-action@v2
      - run: tuist setup cache

yaml

name: Build Application
on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main

env:
  TUIST_TOKEN: ${{ secrets.TUIST_TOKEN }}

jobs:
  build:
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v4
      - run: brew install --formula [email protected]
      - run: tuist setup cache

OIDC 设置

在使用 OIDC 身份验证之前，你需要将你的 GitHub 仓库连接到你的 Tuist 项目。permissions: id-token: write是 OIDC 正常工作所必需的。或者，你可以使用带有TUIST_TOKEN秘密的账户令牌。

Tip

我们建议在你的 Tuist 项目中使用mise use --pin来固定跨环境的 Tuist 版本。该命令将创建一个包含 Tuist 版本的.tool-versions文件。

Xcode Cloud#

在Xcode Cloud中（它以 Xcode 项目为唯一事实来源），你需要添加一个克隆后脚本来安装 Tuist 并运行所需的命令，例如tuist generate：

bash

#!/bin/sh

# Mise installation taken from https://mise.jdx.dev/continuous-integration.html#xcode-cloud
curl https://mise.run | sh # Install Mise
export PATH="$HOME/.local/bin:$PATH"

mise install # Installs the version from .mise.toml

# Runs the version of Tuist indicated in the .mise.toml file {#runs-the-version-of-tuist-indicated-in-the-misetoml-file}
mise exec -- tuist install --path ../ # `--path` needed as this is run from within the `ci_scripts` directory
mise exec -- tuist generate -p ../ --no-open # `-p` needed as this is run from within the `ci_scripts` directory

bash

#!/bin/sh
brew install --formula [email protected]

tuist generate

身份验证

通过在 Xcode Cloud 工作流设置中设置TUIST_TOKEN环境变量，使用账户令牌。

CircleCI#

在CircleCI上，你可以使用OIDC 身份验证来实现安全且无需密钥的身份验证：

yaml

version: 2.1
jobs:
  build:
    macos:
      xcode: "15.0.1"
    steps:
      - checkout
      - run:
          name: Install Mise
          command: |
            curl https://mise.jdx.dev/install.sh | sh
            echo 'export PATH="$HOME/.local/bin:$PATH"' >> $BASH_ENV
      - run:
          name: Install Tuist
          command: mise install
      - run:
          name: Authenticate
          command: mise exec -- tuist auth login
      - run:
          name: Build
          command: mise exec -- tuist setup cache

yaml

version: 2.1
jobs:
  build:
    macos:
      xcode: "15.0.1"
    environment:
      TUIST_TOKEN: $TUIST_TOKEN
    steps:
      - checkout
      - run:
          name: Install Mise
          command: |
            curl https://mise.jdx.dev/install.sh | sh
            echo 'export PATH="$HOME/.local/bin:$PATH"' >> $BASH_ENV
      - run:
          name: Install Tuist
          command: mise install
      - run:
          name: Build
          command: mise exec -- tuist setup cache

身份验证

在使用 OIDC 身份验证之前，你需要将你的 GitHub 仓库连接到你的 Tuist 项目。CircleCI OIDC 令牌包含你连接的 GitHub 仓库，Tuist 使用该信息来授权访问你的项目。或者，你可以使用带有TUIST_TOKEN环境变量的账户令牌。

Bitrise#

在Bitrise上，你可以使用OIDC 身份验证来实现安全且无需密钥的身份验证：

yaml

workflows:
  build:
    steps:
      - git-clone@8: {}
      - script@1:
          title: Install Mise
          inputs:
            - content: |
                curl https://mise.jdx.dev/install.sh | sh
                echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
      - script@1:
          title: Install Tuist
          inputs:
            - content: mise install
      - get-identity-token@0:
          inputs:
          - audience: tuist
      - script@1:
          title: Authenticate
          inputs:
            - content: mise exec -- tuist auth login
      - script@1:
          title: Build
          inputs:
            - content: mise exec -- tuist setup cache

yaml

workflows:
  build:
    steps:
      - git-clone@8: {}
      - script@1:
          title: Install Mise
          inputs:
            - content: |
                curl https://mise.jdx.dev/install.sh | sh
                echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
      - script@1:
          title: Install Tuist
          inputs:
            - content: mise install
      - script@1:
          title: Build
          inputs:
            - content: mise exec -- tuist setup cache

身份验证

在使用 OIDC 身份验证之前，你需要将你的 GitHub 仓库连接到你的 Tuist 项目。Bitrise OIDC 令牌包含你连接的 GitHub 仓库，Tuist 使用该信息来授权访问你的项目。或者，你可以使用带有TUIST_TOKEN环境变量的账户令牌。

Codemagic#

在Codemagic中，你可以向工作流添加一个额外步骤来安装 Tuist：

yaml

workflows:
  build:
    name: Build
    max_build_duration: 30
    environment:
      xcode: 15.0.1
      vars:
        TUIST_TOKEN: ${{ secrets.TUIST_TOKEN }}
    scripts:
      - name: Install Mise
        script: |
          curl https://mise.jdx.dev/install.sh | sh
          mise install # Installs the version from .mise.toml
      - name: Build
        script: mise exec -- tuist setup cache

yaml

workflows:
  build:
    name: Build
    max_build_duration: 30
    environment:
      xcode: 15.0.1
      vars:
        TUIST_TOKEN: ${{ secrets.TUIST_TOKEN }}
    scripts:
      - name: Install Tuist
        script: |
          brew install --formula [email protected]
      - name: Build
        script: tuist setup cache

身份验证

创建一个账户令牌，并将其添加为名为TUIST_TOKEN的秘密环境变量。

Appcircle#

在Appcircle中，你可以使用内置的Tuist Install和Tuist Commands工作流步骤，或者在Git Clone步骤之后添加一个自定义脚本步骤来自行安装 Tuist：

bash

cd $AC_REPOSITORY_DIR
curl https://mise.jdx.dev/install.sh | sh
export PATH="$HOME/.local/bin:$PATH"
mise install
mise exec -- tuist setup cache

bash

cd $AC_REPOSITORY_DIR
brew install --formula [email protected]
tuist setup cache

工作流步骤

Tuist Install 步骤使用 Homebrew 安装 Tuist 并运行tuist generate。设置Tuist Version输入以固定版本，然后添加一个 Tuist Commands 步骤来运行诸如tuist test或tuist build之类的命令。

身份验证

创建一个账户令牌，将其作为名为TUIST_TOKEN的变量添加到环境变量组中，并在构建配置中选择该组。使用锁图标将该变量标记为秘密。

当 Tuist 上传运行时，其仪表板 URL 会打印到日志中。若要在不解析日志的情况下获取这些 URL（例如，在作业失败时将测试报告链接发布到 Slack，或将运行数据馈送到你自己的工具链中），请将--run-report-path（或设置TUIST_RUN_REPORT_PATH）传递给tuist test、tuist xcodebuild test或tuist xcodebuild build。一旦运行上传完成，Tuist 会将 JSON 报告写入该路径：

json

{
  "runId": "0193f8c1-...",
  "status": "success",
  "runURL": "https://tuist.dev/acme/app/runs/0193f8c1-...",
  "testRunURL": "https://tuist.dev/acme/app/tests/test-runs/...",
  "buildRunURL": "https://tuist.dev/acme/app/builds/build-runs/...",
  "testRuns": [
    {
      "scheme": "App",
      "succeeded": true,
      "totalTests": 42,
      "skippedTests": 0,
      "ranTests": 42,
      "failedTestNames": [],
      "ranTestModules": 3,
      "skippedTestModules": 5
    }
  ],
  "buildRuns": [
    { "scheme": "App", "succeeded": true, "durationInSeconds": 12.3 }
  ]
}

字段	类型	描述
`runId`	字符串	运行的唯一标识符。
`status`	字符串	`"success"`或`"failure"`。
`runURL`	字符串	该运行的仪表板 URL。始终存在。
`testRunURL`	字符串？	测试运行的仪表板 URL，在命令执行测试时存在。
`buildRunURL`	字符串？	构建运行的仪表板 URL，在命令执行构建时存在。
`testRuns`	数组	每个 scheme 的测试结果：`scheme`、`succeeded`、`totalTests`、`skippedTests`、`ranTests`、`failedTestNames`、`ranTestModules`和`skippedTestModules`。测试计数针对的是测试用例，`skippedTests`统计结果包报告为跳过的用例。`skippedTestModules`统计被选择性测试跳过的测试模块，当不适用选择性测试或运行是测试分片时，此项会被省略。
`buildRuns`	数组	每个 scheme 的构建结果：`scheme`、`succeeded`、`durationInSeconds`。

testRunURL和buildRunURL相互独立：同时执行构建和测试的命令会写入两者，而日志无法做到这一点——它们每次运行只打印一个 URL。

报告写入时机

报告仅针对上传到服务器的运行写入，这需要身份验证并在 CI 上自动发生。路径在每次运行开始时清除，因此不产生报告的运行不会留下任何内容，而不是留下之前运行的过时报告。

在 GitLab CI 上，常见的用法是通过dotenv报告向后续作业公开 URL：

yaml

test:
  script:
    - tuist test --run-report-path tuist-run.json
    - echo "TUIST_TEST_RUN_URL=$(jq -r '.testRunURL // empty' tuist-run.json)" >> run.env
  artifacts:
    reports:
      dotenv: run.env