გადახტე შინაარსზე

Continuous Integration (CI)

To run Tuist commands in your continuous integration workflows, you'll need to install it in your CI environment.

Authentication is optional but required if you want to use server-side features like cache.

The following sections provide examples of how to do this on different CI platforms.

Examples#

GitHub Actions#

On GitHub Actions you can use OIDC authentication for secure, secretless authentication:

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:tuistauthlogin
-run:tuistsetupcache
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:brewinstall--formula[email protected]
-run:tuistauthlogin
-run:tuistsetupcache
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:tuistsetupcache
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:brewinstall--formula[email protected]
-run:tuistsetupcache
Oidc Setup

Before using OIDC authentication, you need to connect your GitHub repository to your Tuist project. The permissions: id-token: write is required for OIDC to work. Alternatively, you can use an account token with the TUIST_TOKEN secret.

Tip

We recommend using mise use --pin in your Tuist projects to pin the version of Tuist across environments. The command will create a .tool-versions file containing the version of Tuist.

Xcode Cloud#

In Xcode Cloud, which uses Xcode projects as the source of truth, you'll need to add a post-clone script to install Tuist and run the commands you need, for example tuist generate:

bash
#!/bin/sh
# Mise installation taken from https://mise.jdx.dev/continuous-integration.html#xcode-cloud
curlhttps://mise.run|sh# Install Mise
exportPATH="$HOME/.local/bin:$PATH"
miseinstall# Installs the version from .mise.toml
# Runs the version of Tuist indicated in the .mise.toml file
miseexec--tuistinstall--path../# `--path` needed as this is run from within the `ci_scripts` directory
miseexec--tuistgenerate-p../--no-open# `-p` needed as this is run from within the `ci_scripts` directory
bash
#!/bin/sh
brewinstall--formula[email protected]
tuistgenerate
Authentication

Use an account token by setting the TUIST_TOKEN environment variable in your Xcode Cloud workflow settings.

CircleCI#

On CircleCI you can use OIDC authentication for secure, secretless authentication:

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

Before using OIDC authentication, you need to connect your GitHub repository to your Tuist project. CircleCI OIDC tokens include your connected GitHub repository, which Tuist uses to authorize access to your projects. Alternatively, you can use an account token with the TUIST_TOKEN environment variable.

Bitrise#

On Bitrise you can use OIDC authentication for secure, secretless authentication:

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

Before using OIDC authentication, you need to connect your GitHub repository to your Tuist project. Bitrise OIDC tokens include your connected GitHub repository, which Tuist uses to authorize access to your projects. Alternatively, you can use an account token with the TUIST_TOKEN environment variable.

Codemagic#

In Codemagic, you can add an additional step to your workflow to install 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:|
curlhttps://mise.jdx.dev/install.sh|sh
miseinstall# Installs the version from .mise.toml
-name:Build
script:miseexec--tuistsetupcache
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:|
brewinstall--formula[email protected]
-name:Build
script:tuistsetupcache
Authentication

Create an account token and add it as a secret environment variable named TUIST_TOKEN.