持續整合 (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 上傳一次運行時，儀表板網址會打印到日誌中。要喺唔解析日誌嘅情況下獲取佢哋——例如喺工作失敗時將測試報告連結發布到 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`	字串	該運行嘅儀表板網址。必定存在。
`testRunURL`	字串?	測試運行嘅儀表板網址，喺指令執行測試時出現。
`buildRunURL`	字串?	建構運行嘅儀表板網址，喺指令執行建構時出現。
`testRuns`	陣列	每個 Scheme 嘅測試結果：`scheme`、`succeeded`、`totalTests`、`skippedTests`、`ranTests`、`failedTestNames`、`ranTestModules` 同 `skippedTestModules`。測試計數係測試案例數量，而 `skippedTests` 計數結果套件報告為已跳過嘅案例。`skippedTestModules` 計數被選擇性測試跳過嘅測試模組數量，如果無應用選擇性測試或該運行係測試分片，則會省略此欄位。
`buildRuns`	陣列	每個 Scheme 嘅建構結果：`scheme`、`succeeded`、`durationInSeconds`。

testRunURL 同 buildRunURL 係獨立嘅：同時執行建構同測試嘅指令會寫入兩者，但日誌做唔到呢點——日誌每次運行只打印一個網址。

報告寫入時機

報告只會為上傳到伺服器嘅運行寫入，這需要認證並會喺 CI 上自動發生。路徑會喺每次運行開始時清除，所以如果一次運行無產生報告，就唔會留下任何內容，而唔係留下之前運行嘅過時報告。

喺 GitLab CI 上，常見用法係透過 dotenv 報告將網址暴露給後續工作：

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