持續整合 (CI){#continuous-integration-ci}

若要在 continuous integration 工作流程中執行 Tuist 指令，您需要在 CI 環境中安裝。

驗證是可選的，但如果您要使用

cache

等伺服器端功能，則需要驗證。

以下各節將舉例說明如何在不同的 CI 平台上執行。

範例{#examples}#

GitHub 動作{#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 Setup

在使用 OIDC 認證之前，您需要將 GitHub 倉庫連接到您的 Tuist 專案。要使用 OIDC，需要permissions: id-token: write 。另外，您也可以使用 Project token 與TUIST_TOKEN secret。

Tip

我們建議在您的 Tuist 專案中使用mise use --pin 來釘住跨環境的 Tuist 版本。該指令會建立.tool-versions 檔案，其中包含 Tuist 的版本。

Xcode 雲端{#xcode-cloud}#

在使用 Xcode 專案作為真相來源的 Xcode Cloud 中，您需要新增 post-clone 指令碼來安裝 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
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

Authentication

透過在 Xcode Cloud 工作流程設定中設定TUIST_TOKEN 環境變數，使用 project token 。

CircleCI{#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

Authentication

在使用 OIDC 認證之前，您需要將您的 GitHub 倉庫連接到您的 Tuist 專案。CircleCI OIDC 令牌包含您已連接的 GitHub 倉庫，Tuist 會使用它來授權存取您的專案。另外，您也可以使用TUIST_TOKEN 環境變數來使用專案代碼。

Bitrise{#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

Authentication

在使用 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

Authentication

建立 project token 並將其新增為秘密環境變數，名稱為TUIST_TOKEN 。