Перейти к содержимому

GitLab CI

Только по приглашению

Tuist Runners в настоящее время доступны только по приглашению. Свяжитесь с нами или напишите нам в Slack-сообществе, чтобы запросить доступ для вашего аккаунта.

Ваши пайплайны остаются в GitLab. Tuist предоставляет изолированную машину на базе Linux или macOS для каждой задачи и отправляет её логи и результат в GitLab и на панель управления Tuist. Требуется GitLab версии 19.3 или новее. Поддерживаются GitLab.com и самостоятельно размещаемые экземпляры, доступные через публичный HTTPS.

  1. Создайте раннер GitLab. В разделе проекта Settings → CI/CD → Runners создайте проектный раннер. Также можно использовать групповой раннер. Добавьте все метки профилей Tuist, которые вы хотите использовать как теги раннера, например tuist-linux и tuist-macos, и отключите опцию Run untagged jobs. Сохраните токен аутентификации, который покажет GitLab; он начинается с glrt-. Устанавливать раннер на свою машину не нужно.

  2. Подключитесь к Tuist один раз. В разделе Settings → Integrations выберите Connect на карточке GitLab CI. Введите URL вашего GitLab и токен аутентификации раннера. Одно подключение может обслуживать задачи с разными профилями. Токены хранятся в зашифрованном виде и больше не отображаются. При желании добавьте токен доступа к API, чтобы пайплайны merge request могли сохранять тома кэша; см. Merge request pipelines.

  3. Выберите машину для каждой задачи. Укажите ровно одну метку профиля Tuist в поле tags задачи. Другие теги допустимы, если они также есть у зарегистрированного раннера GitLab:

    yaml
    # .gitlab-ci.yml
    linux-check:
    tags: [tuist-linux]
    script:
    - uname -a
    test:
    tags: [tuist-macos]
    script:
    - tuist test
    retry:
    max: 2
    when: runner_system_failure
  4. Отправьте изменения и наблюдайте. Tuist начнёт опрос в течение минуты. Задачи появятся в разделе Runners со ссылкой на задачу в GitLab, логами и метриками машины. GitLab получает логи во время выполнения задачи; Tuist получает замаскированный лог после её завершения.

Tuist читает CI_JOB_TAGS из каждого назначения и определяет профиль в рамках подключённого аккаунта Tuist. Он не выводит тип машины из CI_RUNNER_TAGS и не использует профиль по умолчанию. Если метки профиля Tuist отсутствуют, неизвестны или их несколько, полученная задача завершается с ошибкой, а в логе GitLab появляется пояснение. Не переопределяйте CI_JOB_TAGS в переменных пайплайна.

Среда выполнения#

Задачи используют shell executor GitLab внутри изолированной машины. Checkout, переменные CI, before_script, script, after_script, артефакты и отмена обрабатываются GitLab Runner. Настройки пайплайна image: и services: не конфигурируют эту shell-среду; используйте инструменты, установленные в образе раннера, или устанавливайте их в своём скрипте.

Многоразовый токен аутентификации раннера остаётся на сервере Tuist. Машины получают учётные данные только для назначенной им задачи. Права на подпись кэша сейчас не выдаются для задач GitLab. Пользовательские тома кэша Linux проверяют идентичность задачи и право на запись через API GitLab; перезаписываемые переменные CI не обеспечивают доверия.

GitLab помечает задачу как выполняющуюся и запускает её тайм-аут сразу после того, как Tuist получит её. Пока задачи, уже полученные Tuist, занимают лимит параллельности вашего аккаунта, остальные задачи остаются в состоянии ожидания в GitLab. Полученная задача ожидает машину вплоть до своего тайм-аута, но не более 12 часов. Если к этому времени машина не станет доступна, Tuist завершит назначение с ошибкой runner_system_failure, а указанная выше политика повторных попыток позволит GitLab повторить её. Та же политика применяется при потере машины раннера.

Ротация токенов и отключение#

Обновите токены подключения и выберите Save changes, чтобы выполнить их ротацию. Если оставить поле токена пустым, существующий учётный данные сохранится.

Disconnect останавливает получение новых задач и завершает ожидающие назначения с ошибкой. Выполняющиеся задачи продолжают работу со своими учётными данными. Если GitLab недоступен, Tuist сохраняет отключённое подключение, повторно пытаясь отменить ожидающие назначения. Подключение удаляется после завершения этих назначений.

Тома кэша#

Сохраняйте кэши Xcode, модулей и Gradle, а также другие директории между задачами с помощью томов кэша. Добавляйте их после checkout и перед командами, которые их используют.

Пайплайны merge request#

Push-, schedule- и web-пайплайны проекта сохраняют свои изменения в тома кэша. Пайплайны merge request используют кэш и сохраняют изменения только если у подключения есть токен доступа к API:

  1. В GitLab создайте токен доступа проекта или группы с ролью Reporter и областью действия read_api. Групповой токен охватывает все проекты группы, использующие раннеры Tuist.
  2. В разделе Settings → Integrations вставьте его в поле API access token на карточке GitLab CI и выберите Save changes.

Затем Tuist читает merge request каждого пайплайна merge request. Пайплайны merge request, открытые из ветки самого проекта, сохраняют изменения под исходной веткой merge request, поэтому настройки веток профиля раннера применяются к этой ветке. Merge request из форков никогда не сохраняют изменения. Если Tuist не может прочитать merge request, задача всё равно выполняется и использует кэш, но её изменения отбрасываются.