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

Сгенерированный проект Xcode

Note

Автоматически созданные схемы по умолчанию включают пост-действие tuist inspect build.

Если вы не хотите отслеживать аналитику сборок в сгенерированных схемах, отключите эту функцию с помощью buildInsightsDisabled.

Если вы используете сгенерированные проекты с пользовательскими схемами, необходимо добавить пост-действие самостоятельно. Для Mise:

swift
let project = Project(
name: "MyProject",
targets: [
// Your targets
],
schemes: [
.scheme(
name: "MyApp",
shared: true,
buildAction: .buildAction(
targets: ["MyApp"],
postActions: [
.executionAction(
title: "Inspect Build",
scriptText: """
$HOME/.local/bin/mise x -C $SRCROOT -- tuist inspect build
""",
target: "MyApp"
)
],
runPostActionsOnFailure: true
),
runAction: .runAction(configuration: "Debug")
)
]
)

Если вы не используете Mise, убедитесь, что tuist доступен в окружении схемы, так как пост-действия Xcode не наследуют переменную PATH вашей оболочки. Для установок через Homebrew:

swift
buildAction: .buildAction(
targets: ["MyApp"],
postActions: [
.executionAction(
title: "Inspect Build",
scriptText: """
export PATH="/opt/homebrew/bin:/usr/local/bin:$PATH"
tuist inspect build
""",
target: "MyApp"
)
],
runPostActionsOnFailure: true
)

Аналитика сборок в CI#

Чтобы отслеживать аналитику сборок в CI, убедитесь, что CI аутентифицирован.

Для CI на базе Xcodebuild необходимо:

  • Используйте tuist xcodebuild при вызове действий xcodebuild.
  • Добавьте -resultBundlePath в команду xcodebuild.

Без -resultBundlePath необходимые журналы активности и пакеты результатов не создаются, и tuist inspect build не может проанализировать сборку.

Публикация отчётов без учётных данных в частной сети#

Развёртывание на собственном сервере позволяет разработчикам публиковать готовые отчёты без входа в систему. Оператор должен настроить TUIST_NETWORK_TRUSTED_INSIGHTS_ACCESS=true на экземпляре и перезапустить его, как описано в руководстве по самостоятельному размещению. Это относится ко всем поддерживаемым проектам; отдельной настройки в панели управления нет. Настройте URL-адрес собственного сервера и проект в окружении, используемом пост-действием вашей схемы или терминалом. CLI автоматически определяет политику экземпляра, если учётные данные отсутствуют:

bash
export TUIST_URL="https://tuist.internal.example"
tuist inspect build
# To publish local test results:
tuist inspect test

При полном отсутствии учётных данных журналы активности и пакеты XCResult анализируются локально и отправляются в виде структурированных отчётов. Не передаются необработанные архивы, вложения, данные покрытия/истории, удалённые процессоры, ссылки на шарды или доказательства выборочного выполнения. Отчёты остаются видимыми, но не могут обновлять состояние аутентифицированных тестовых случаев или запускать автоматизацию карантина/сбоев. Для доступа к панелям управления и другим привилегированным командам всё ещё требуется вход в систему. Оставьте интеграцию кэша отключённой, если экземпляр отдельно не включает доверенный сетевой доступ к кэшу или не предоставлены учётные данные.

Текущие учётные данные остаются аутентифицированными. Недействительные, повреждённые, пустые или отклонённые при обновлении учётные данные приводят к отказу в доступе и сохраняются на диске, поэтому последующие команды не становятся неавторизованными незаметно. Войдите в систему снова или явно выйдите из неё как осознанное действие восстановления. Обновите каждую реплику сервера до версии с поддержкой обнаружения перед обновлением клиентов, работающих без учётных данных, и настройте конечный URL-адрес сервера без перенаправлений. Старые серверы без поддержки обнаружения, отключённые экземпляры и сбои обнаружения по-прежнему требуют аутентификации. Опциональное включение на стороне клиента не требуется. Установите TUIST_ACTOR_ID="" отдельно, чтобы исключить настроенное утверждение об акторе; проверенная идентичность учётных данных не затрагивается.

Метрики машины#

Аналитика сборок может включать метрики производительности на уровне машины (ЦП, память, сеть и использование диска), собранные во время сборки. Чтобы включить эту функцию, настройте легковесный фоновый демон, который постоянно опрашивает системные метрики:

bash
tuist setup insights

Это запускает локальный демон, который опрашивает метрики в фоновом режиме. Данные автоматически собираются tuist inspect build и загружаются вместе с отчетом о сборке.

Метрики диска включают активность чтения/записи и, при использовании совместимого CLI и сервера, общий объем и доступное пространство на томе данных системы macOS (/System/Volumes/Data). Доступное пространство не включает очищаемое место. Диаграмма использования диска показывает занятое пространство (общее минус доступное) вместе с общей емкостью за время сборки, а не только на момент загрузки. Она не измеряет отдельные внешние тома, используемые для клонирования репозитория или DerivedData.

После обновления CLI перезапустите существующий сборщик метрик с помощью tuist teardown insights, а затем tuist setup insights. Сбор метрик должен работать во время сборки; старые отчеты и неудачные измерения не содержат значений использования диска и не отображаются как нулевые. Выборки использования диска подчиняются существующему правилу хранения метрик машины в течение 90 дней.

CI

Выполните tuist setup insights на ваших CI-машинах перед сборкой, чтобы собирать метрики машины и там.

Чтобы прекратить сбор метрик машины, выполните:

bash
tuist teardown insights

Это выгружает LaunchAgent демона, удаляет его plist и удаляет собранные метрики и логи демона из ~/.local/state, поэтому в фоновом режиме ничего не остается работать.

Заявление об акторе отчёта#

Запросы на создание отчётов включают необязательный заголовок x-tuist-actor-id только в том случае, если вы явно задаёте TUIST_ACTOR_ID в виде метки, ограниченной организацией, например TUIST_ACTOR_ID=employee-123 tuist inspect build. По умолчанию метка не отправляется, и Tuist не определяет имена пользователей операционной системы. Пустое значение TUIST_ACTOR_ID исключает передаваемый идентификатор, но не удаляет верифицированную личность на основе учётных данных. Идентификаторы должны состоять из 1–128 байт печатных символов ASCII, кроме пробела; недопустимые переопределения игнорируются без возврата к предыдущему значению. Если пользовательский прокси отклоняет неизвестные заголовки, откажитесь от передачи, установив пустое переопределение через переменную окружения.

Верифицированные индивидуальные учётные данные имеют приоритет; идентификаторы, переданные клиентом, в остальных случаях отображаются как Неверифицировано и никогда не предоставляют права доступа и не связываются с пользователями автоматически. Идентификаторы видны всем, кто может просматривать отчёты проекта, включая публичных зрителей, если проект публичный, и включаются в экспорт данных, поэтому не добавляйте в них секреты. Это относится к отчётам о сборках, тестах и событиях команд. Старые серверы игнорируют этот необязательный заголовок, а новые серверы принимают старых клиентов без него. Новые отчёты с общим токеном без идентификатора показывают Неизвестно, а не публикующую организацию; исторические отчёты сохраняют прежнюю атрибуцию. В списках сборок и тестов верифицированные пользователи отделены от неверифицированных переданных идентификаторов. Аутентификация остаётся обязательной, если только саморазвёрнутый экземпляр явно не включает отчётность без учётных данных и клиент не обнаруживает эту политику.

Пост-действия схемы#

Заявления об акторах по умолчанию отключены. Чтобы настроить такое заявление для пост-действия схемы, задайте TUIST_ACTOR_ID непосредственно в этом скрипте, а не полагайтесь на экспорт переменных оболочки. Xcode, запущенный из Dock, не наследует переменные из ~/.zshrc. Чтобы явно подавить настроенное заявление при использовании Homebrew, выполните:

bash
export PATH="/opt/homebrew/bin:/usr/local/bin:$PATH"
export TUIST_ACTOR_ID=""
tuist inspect build

При использовании Mise переопределите значение после загрузки окружения Mise:

bash
$HOME/.local/bin/mise x -C "$SRCROOT" -- env TUIST_ACTOR_ID="" tuist inspect build

Чтобы включить передачу, используйте явную метку вместо пустого значения.

Пользовательские метаданные#

Вы можете прикреплять метаданные к сборкам с помощью переменных окружения, чтобы улучшить фильтрацию.

Переменные окружения#

Переменная Формат Описание
TUIST_BUILD_TAGS Разделено запятыми Несколько тегов в одной переменной.
TUIST_BUILD_VALUE_* Одно значение Пара «ключ-значение», где суффикс является ключом.

Примеры#

Установите эти значения в CI или в вашей оболочке перед запуском сборки:

bash
export TUIST_BUILD_TAGS="nightly,ios-team,release-candidate"
bash
export TUIST_BUILD_VALUE_TICKET="PROJ-1234"
export TUIST_BUILD_VALUE_PR_URL="https://github.com/myorg/myrepo/pull/123"