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

Проект Bazel

plaintext
Help me get started with Tuist. Follow the setup at:
https://tuist.dev/en/docs/guides/get-started/bazel-project

Следуйте этому пути, чтобы подключить существующее рабочее пространство Bazel к Tuist. Tuist предоставляет кэш Remote Execution API, к которому Bazel подключается как к удаленному кэшу, а также поток Build Event Service, который превращает каждую сборку и тест в видимые данные на панели управления.

Каждый раздел ниже начинается с описания того, чего не хватает сегодня, а затем проводит вас через функцию, которая заполняет этот пробел.

Предварительные требования#

Подключение рабочего пространства#

Из корня рабочего пространства Bazel выполните команду tuist init. Tuist обнаруживает WORKSPACE / MODULE.bazel и предлагает опцию Интегрировать рабочее пространство Bazel. Пройдите аутентификацию в браузере и выберите аккаунт, которому должен принадлежать проект.

bash
tuist init

Если вы выполняете это действие через агент для написания кода или скрипт, сначала запустите tuist auth login (браузерный процесс ожидает нажатия клавиши Enter), затем используйте неинтерактивную форму:

bash
tuist init --build-system bazel --name <project-handle> --account <account>

После завершения инициализации Tuist:

  1. Создает файл tuist.toml в корне рабочего пространства с идентификатором проекта.
  2. Создает файл .bazelrc.tuist рядом с вашим .bazelrc, настроенный на ближайший регион кэша Tuist и аутентифицированный через вспомогательный инструмент учетных данных для каждого рабочего пространства.
  3. Добавляет строку try-import %workspace%/.bazelrc.tuist в ваш .bazelrc.

Зафиксируйте строку try-import в системе контроля версий. Она одинакова на всех машинах. Добавьте .bazelrc.tuist в ваш .gitignore. Путь к вспомогательному инструменту учетных данных зависит от пользователя, а регион кэша — от местоположения, поэтому их не следует передавать другим.

Все функции ниже включаются автоматически после подключения рабочего пространства.

Удаленный кэш#

Собственный локальный дисковый кэш Bazel находится в папке ~/.cache/bazel (или там, куда указывает --disk_cache). Попадание в кэш на машине одного разработчика недоступно другим, а контейнеры задач CI каждый раз запускаются с пустым кэшем.

Remote Execution API от Bazel — это протокол для расширения этого же кэша до общей конечной точки. Tuist поддерживает этот протокол. Как только .bazelrc.tuist настроен, Bazel пропускает действия, результаты которых уже есть в общем кэше, и загружает их вместо выполнения. Работа одной машины приносит пользу всем остальным машинам, собирающим ту же ревизию.

Проверьте, выполнив две чистые сборки для одной и той же ревизии (локально или одну локальную и одну в CI):

bash
bazel clean
bazel build //...

Отчет второго запуска должен показывать попадания в кэш. Откройте раздел Кэш на панели управления, чтобы увидеть процент попаданий за определенный период.

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

Поток событий сборки Bazel и XML-отчеты по каждому тесту генерируются при каждом вызове. Сравнение длительности выполнения целей в течение недели или выявление теста, ставшего нестабильным за несколько запусков в CI, требует сбора и агрегации этих событий в одном месте.

Протокол Build Event Service, который уже генерирует Bazel, предназначен именно для этого. Файл .bazelrc.tuist, созданный tuist init, настраивает поток BES для взаимодействия с Tuist, поэтому данные аналитики сборок и тестов начинают поступать при следующем выполнении bazel build и bazel test. Дополнительная настройка не требуется. Откройте разделы Сборки и Тесты на панели управления, чтобы увидеть данные.

Подключите команду#

Попадания в кэш и аналитика становятся более ценными с увеличением числа людей, подключенных к проекту. Пригласите своих коллег в организацию через настройки аккаунта на панели управления и настройте единый вход (SSO) (Google, Okta, Microsoft), чтобы подключение новых участников происходило в один клик, а не требовало индивидуального выполнения tuist auth login для каждого человека.