지속적 통합(CI)

지속적 통합 워크플로에서 Tuist 명령을 실행하려면 CI 환경에 Tuist를 설치해야 합니다.

인증은 선택 사항이지만, 캐시와 같은 서버 측 기능을 사용하려면 필수입니다.

다음 섹션에서는 다양한 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 프로젝트와 연동해야 합니다. OIDC가 작동하려면 permissions: id-token: write이 필요합니다. 대신 TUIST_TOKEN 시크릿과 함께 계정 토큰을 사용할 수도 있습니다.

Tip

Tuist 프로젝트에서 mise use --pin을 사용하여 환경 간 Tuist 버전을 고정하는 것을 권장합니다. 이 명령은 Tuist 버전이 포함된 .tool-versions 파일을 생성합니다.

Xcode Cloud#

Xcode 프로젝트를 신뢰 소스로 사용하는 Xcode Cloud에서는 Tuist를 설치하고 필요한 명령(예: tuist generate)을 실행하기 위해 post-clone 스크립트를 추가해야 합니다.

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 단계 뒤에 Custom Script 단계를 추가하여 직접 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에 게시하거나 자체 도구에 실행 데이터를 전달하기 위해) tuist test, tuist xcodebuild test 또는 tuist xcodebuild build에 --run-report-path(또는 TUIST_RUN_REPORT_PATH 설정)를 전달하세요. 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`	string	실행의 고유 식별자입니다.
`status`	string	`"success"` 또는 `"failure"`입니다.
`runURL`	string	실행에 대한 대시보드 URL입니다. 항상 존재합니다.
`testRunURL`	string?	테스트 실행에 대한 대시보드 URL로, 명령이 테스트를 실행할 때 존재합니다.
`buildRunURL`	string?	빌드 실행에 대한 대시보드 URL로, 명령이 빌드를 수행할 때 존재합니다.
`testRuns`	array	스키마별 테스트 결과: `scheme`, `succeeded`, `totalTests`, `skippedTests`, `ranTests`, `failedTestNames`, `ranTestModules` 및 `skippedTestModules`. 테스트 카운트는 테스트 케이스 수이며, `skippedTests`는 결과 번들이 건너뛰었다고 보고한 항목의 수를 나타냅니다. `skippedTestModules`는 선택적 테스팅으로 건너뛴 테스트 모듈 수를 나타내며, 선택적 테스팅이 적용되지 않거나 실행이 테스트 샤드인 경우 생략됩니다.
`buildRuns`	array	스키마별 빌드 결과: `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