გადადით შინაარსზე

უწყვეტი ინტეგრაცია (CI)

იმისთვის, რომ Tuist-ის ბრძანებები თქვენს უწყვეტი ინტეგრაციის სამუშაო პროცესებში შეასრულოთ, ის უნდა დააინსტალიროთ CI გარემოში.

ავტორიზაცია სავალდებულო არ არის, მაგრამ აუცილებელია, თუ სერვერის მხარის ფუნქციების, მაგალითად ქეშის, გამოყენება გსურთ. Tuist-ის დაინსტალირების შემდეგ CI გაშვებების დროის შესამცირებლად და ხარჯების შესამცირებლად იხილეთ ნელი ბილდები და CI ხარჯები.

შემდეგი სექციები მოიცავს მაგალითებს, თუ როგორ განახორციელოთ ეს სხვადასხვა CI პლატფორმაზე. Once უკავშირდება საკუთარი ნატიური Tuist პროვაიდერის მეშვეობით; მას Tuist CLI არ სჭირდება. ამ სამუშაო პროცესისთვის იხილეთ Once.

Once#

დააკომიტეთ პროვაიდერი და ქეშის მიბმა Once-თან დაწყების სახელმძღვანელოს მიხედვით. დააინსტალირეთ Once ჯობში Once-ის ინსტალაციის ინსტრუქციების გამოყენებით, შემდეგ კი გაიარეთ ავტორიზაცია ქეშირებადი სამუშაოს შესრულებამდე.

GitHub Actions, CircleCI და Bitrise მხარს უჭერენ Once-ის უინტერაქციო OpenID Connect შესვლას. დააკავშირეთ რეპოზიტორი თქვენს Tuist პროექტთან OIDC ავტორიზაციის აღწერის შესაბამისად. GitHub Actions-ზე მიანიჭეთ identity-token ნებართვა:

yaml
permissions:
id-token: write
contents: read
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: jdx/mise-action@v2
# Pin Once in your repository's mise.toml.
- run: once auth login --provider tuist --no-browser
- run: once build MyTarget
- run: once test

აირჩიეთ ოპერაციული სისტემა, რომელიც შეიცავს თქვენი ტარგეტებისთვის საჭირო ტულჩეინებს. ჩაანაცვლეთ MyTarget თქვენი ტარგეტით და დააფიქსირეთ Once თქვენი არსებული ინსტრუმენტების ინსტალაციის სამუშაო პროცესის მეშვეობით. მიღებული სესია ხელახლა გამოიყენება ქეშზე წვდომის, ანგარიშგების და არტეფაქტების გამოქვეყნებისთვის ჯობის განმავლობაში.

სხვა პროვაიდერებზე, დააყენეთ TUIST_TOKEN ანგარიშის ტოკენად, რომელიც ავტორიზებულია თქვენთვის საჭირო ოპერაციებისთვის. შეინახეთ ის CI საიდუმლოების საცავში, არასდროს once.toml-ში ან სამუშაო პროცესის წყაროში. ამ ტოკენის გამოყენებისას ინტერაქციული შესვლის ეტაპი არ არის საჭირო.

მრავალმუშაკიანი სუიტებისთვის მიჰყევით Once ტესტების შარდინგს. აპლიკაციების გამოქვეყნებისთვის დაამატეთ ცალსახა Once პრივიუს გამოქვეყნების ეტაპი. ჩვეულებრივი ბილდები პრივიუსებს არ აქვეყნებენ იმპლიციტურად.

მაგალითები#

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 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 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 4.218.0-დან, CLI ცვლის იდენტობის ტოკენს თავის პირველ მოთხოვნაზე, ამიტომ სამუშაო პროცესს tuist auth login ეტაპი არ სჭირდება; ადრეულ ვერსიებზე, სხვა Tuist ბრძანებებამდე შეასრულეთ tuist auth login. ალტერნატიულად, შეგიძლიათ გამოიყენოთ ანგარიშის ტოკენი TUIST_TOKEN საიდუმლოებით.

Tip

გირჩევთ გამოიყენოთ mise use --pin თქვენს Tuist პროექტებში, რათა დააფიქსიროთ Tuist-ის ვერსია გარემოებს შორის. ბრძანება აფიქსირებს Tuist-ის ვერსიას თქვენს mise.toml ფაილში.

Xcode Cloud#

Xcode Cloud-ში, რომელიც Xcode პროექტებს იყენებს როგორც ჭეშმარიტების წყაროს, უნდა დაამატოთ 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
ავტორიზაცია

გამოიყენეთ ანგარიშის ტოკენი TUIST_TOKEN გარემოს ცვლადის დაყენებით თქვენს Xcode Cloud სამუშაო პროცესის პარამეტრებში.

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: 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 4.218.0-დან, CLI ცვლის იდენტობის ტოკენს თავის პირველ მოთხოვნაზე, ამიტომ tuist auth login ეტაპი არ არის საჭირო; ადრეულ ვერსიებზე, სხვა Tuist ბრძანებებამდე შეასრულეთ mise exec -- tuist auth login. ალტერნატიულად, შეგიძლიათ გამოიყენოთ ანგარიშის ტოკენი 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: 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 4.218.0-დან, CLI ცვლის იდენტობის ტოკენს თავის პირველ მოთხოვნაზე, ამიტომ tuist auth login ეტაპი არ არის საჭირო; ადრეულ ვერსიებზე, სხვა Tuist ბრძანებებამდე შეასრულეთ mise exec -- tuist auth login. ალტერნატიულად, შეგიძლიათ გამოიყენოთ ანგარიშის ტოკენი 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 სამუშაო პროცესის ეტაპები, ან დაამატოთ Custom Script ეტაპი 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 ეტაპი აყენებს Tuist-ს Homebrew-ით და ასრულებს tuist generate. მიანიჭეთ Tuist Version შეყვანას ვერსია, რათა დააფიქსიროთ ის, შემდეგ კი დაამატეთ Tuist Commands ეტაპი ისეთი ბრძანებების შესასრულებლად, როგორიცაა tuist test ან tuist build.

ავტორიზაცია

შექმენით ანგარიშის ტოკენი, დაამატეთ ის როგორც ცვლადი სახელით TUIST_TOKEN გარემოს ცვლადების ჯგუფში და აირჩიეთ ეს ჯგუფი თქვენს აგების კონფიგურაციაში. მონიშნეთ ცვლადი როგორც საიდუმლო ჩაკეტვის ხატულათი.

xcodebuild გამოტანის ფორმატირება#

tuist build, tuist test, tuist xcodebuild build და tuist xcodebuild test აფორმატებენ xcodebuild-ის გამოტანას xcbeautify-ის ფორმატერით, ამიტომ არ გჭირდებათ ამ ბრძანებების xcbeautify-ში გატარება. GitHub Actions-ზე, რომელიც აღმოჩენილია GITHUB_ACTIONS გარემოს ცვლადით, Tuist იყენებს xcbeautify-ის GitHub Actions რენდერერს, რომელიც კომპილატორის გაფრთხილებებს, შეცდომებს და ტესტების ჩავარდნებს აჩვენებს ანოტაციების სახით გაშვების შეჯამებაში და pull request-ზე. ყველა სხვა ადგილას ის იყენებს ტერმინალის რენდერერს, ფერადს, თუ გამოტანა არ არის გატარებული ან NO_COLOR არ არის დაყენებული.

გადაეცით --verbose, რათა დაბეჭდოთ xcodebuild-ის დაუფორმატებელი გამოტანა, მაგალითად, როდესაც აგება იჭედება ცხადი შეცდომის გარეშე.

თუ სამუშაო პირდაპირ უწოდებს xcodebuild-ს Tuist-ის ნაცვლად, თავად გაატარეთ ის xcbeautify-ში და დააყენეთ pipefail, რათა ჩავარდნილმა აგებამ მაინც ჩააგდოს ეტაპი:

bash
set -o pipefail
xcodebuild test -scheme App | xcbeautify --renderer github-actions

გაშვების ანგარიში#

როდესაც Tuist ატვირთავს გაშვებას, მისი დაფის 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, succeeded, totalTests, skippedTests, ranTests, failedTestNames, ranTestModules და skippedTestModules. ტესტების რაოდენობა ეხება ტესტის საქმეებს, ხოლო skippedTests ითვლის იმას, რასაც შედეგების ბუნდლი აცხადებს როგორც გამოტოვებულს. skippedTestModules ითვლის ტესტის მოდულებს, რომლებიც შერჩევითმა ტესტირებამ გამოტოვა, და გამოტოვებულია, როდესაც შერჩევითი ტესტირება არ გამოყენებულა ან გაშვება არის ტესტის ნაწილი.
buildRuns მასივი სქემის მიხედვით აგების შედეგები: scheme, succeeded, durationInSeconds.

testRunURL და buildRunURL დამოუკიდებელია: ბრძანება, რომელიც ასრულებს აგებასაც და ტესტირებასაც, წერს ორივეს, რასაც ჟურნალები ვერ აკეთებენ — ისინი მხოლოდ ერთ URL-ს ბეჭდავენ გაშვებაზე.

როდის იწერება ანგარიში

ანგარიში იწერება მხოლოდ იმ გაშვებებისთვის, რომლებიც აიტვირთა სერვერზე, რაც მოითხოვს ავტორიზაციას და ხდება ავტომატურად CI-ზე. გზა იწმინდება ყოველი გაშვების დასაწყისში, ამიტომ გაშვება, რომელიც არ ქმნის ანგარიშს, არაფერს ტოვებს, ნაცვლად წინა გაშვების მოძველებულისა.

GitLab CI-ზე, ჩვეულებრივი გამოყენებაა URL-ის გამოტანა მოგვიანებითი სამუშაოებისთვის 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