Lane — что это, создание и использование в Fastlane

Что такое Lane в Fastlane

Lane — это базовый строительный блок Fastlane, определяющий именованный сценарий автоматизации. Каждый lane описывает последовательность действий (actions), которые выполняются для достижения конкретной цели: собрать приложение, запустить тесты, загрузить билд в магазин или настроить окружение. Lane объявляется в Fastfile и запускается командой fastlane [имя_lane] из корня проекта.

Концепция lane заимствована из Ruby DSL и обеспечивает читаемость сценариев. Разработчик видит весь CI/CD процесс как последовательность вызовов actions с понятными именами и параметрами. Lane может быть простым (одна команда) или сложным (ветвления, циклы, вызов других lanes).

Каждый lane после выполнения возвращает результат — объект, содержащий статус выполнения и данные от actions. Результат может быть использован в других lanes или передан в CI/CD систему для принятия решений. Если любой action в lane завершается ошибкой, выполнение lane останавливается и вызывается блок error.

Синтаксис lane: объявление и запуск

Синтаксис объявления lane следует простому паттерну Ruby DSL: ключевое слово lane, имя сценария в виде символа Ruby (symbol), блок do ... end с телом сценария. Имя lane должно быть уникальным в пределах платформы и состоять из букв, цифр и нижних подчёркиваний.

Запуск lane выполняется через командную строку: fastlane build (для lane с именем :build) или bundle exec fastlane build (если Fastlane установлен через Bundler). Для платформенных lanes используйте fastlane ios build или fastlane android build.

# Объявление простого lane
lane :test do
  scan(scheme: 'App', devices: ['iPhone 15'])
end

lane :build_and_deploy do
  cocoapods
  test
  gym(scheme: 'App', export_method: 'app-store')
  pilot(skip_waiting_for_build_processing: true)
end

# Запуск: fastlane build_and_deploy

Lane может содержать условную логику на основе параметров или переменных окружения. Используйте if/unless для пропуска шагов в определённых условиях. Также доступны циклы each для обработки массивов, что удобно для сборки нескольких таргетов или схем приложения в одном lane.

Возврат значения из lane

Lane может возвращать значение, которое будет доступно вызывающему коду. Для возврата используется обычный Ruby return или последнее выражение в блоке lane. Возвращаемое значение может быть строкой, числом, хэшем или результатом action. Это позволяет использовать результат одного lane в другом lane для принятия решений.

Например, lane :get_version может вернуть текущую версию приложения из Info.plist, а lane :deploy использовать её для формирования сообщения в Slack. Возвращаемые значения особенно полезны в private lanes, где результат нужен для дальнейшей обработки в вызывающем lane.

Параметры lanes: передача и обработка

Параметры lane делают сценарии гибкими и переиспользуемыми. Lane принимает параметры через options хэш, который передаётся при запуске из командной строки: fastlane deploy scheme:AppStore version:2.1.0. Внутри lane параметры доступны как options[:scheme] и options[:version].

Для обязательных параметров проверяйте наличие значения в начале lane и вызывайте UI.user_error! с понятным сообщением. Для необязательных параметров задавайте значения по умолчанию через оператор ||. Fastlane также поддерживает типизированные параметры через метод options с указанием типа, значения по умолчанию и описания.

# Lane с обработкой параметров
lane :deploy do |options|
  scheme = options[:scheme]
  version = options[:version] || '1.0.0'
  beta = options[:beta] || false

  UI.user_error!("Не указан scheme") unless scheme

  match(type: beta ? 'adhoc' : 'appstore')
  gym(scheme: scheme, export_method: beta ? 'ad-hoc' : 'app-store')

  if beta
    pilot(distribute_external: true)
  else
    deliver(submit_for_review: true)
  end
end

# Запуск: fastlane deploy scheme:MyApp beta:true version:2.1.0

Для работы с переменными окружения внутри lane используйте ENV['VARIABLE_NAME']. Fastlane автоматически загружает .env файлы из директории fastlane. Это стандартный способ передачи чувствительных данных — API ключей, паролей и токенов — в CI/CD окружении без хранения их в Fastfile.

Валидация параметров

Для надёжной работы lane необходима валидация параметров на входе. Используйте UI.user_error! с описанием проблемы, если обязательный параметр отсутствует или имеет неверный тип. Fastlane предоставляет метод options, позволяющий задать тип (String, Boolean, Integer, Array), значение по умолчанию и описание для каждого параметра — валидация выполняется автоматически при запуске lane.

Дополнительно можно использовать проверки через verify блок: verify do |value| value.length > 0 end для строковых параметров. При неверном формате Fastlane выводит понятное сообщение с указанием ожидаемого формата и переданного значения, что упрощает отладку в CI/CD окружении.

Объединение lanes: before_all, after_all и error обработка

Fastlane предоставляет хуки жизненного цикла для выполнения кода до и после каждого lane. Блок before_all выполняется перед каждым lane в данной платформе или глобально. Блок after_all выполняется после успешного завершения lane. Блок error выполняется при любой ошибке внутри lane.

Хуки позволяют централизовать повторяющуюся логику: установка зависимостей в before_all, отправка уведомлений в after_all, очистка временных файлов и уведомление об ошибках в error блоке. Это уменьшает дублирование кода и делает lanes чище.

# Хуки жизненного цикла lanes
default_platform(:ios)

before_all do
  cocoapods(try_repo_update_on_error: true)
  ensure_git_status_clean
end

after_all do |lane|
  slack(message: "Lane #{lane} выполнен успешно")
end

error do |lane, exception|
  slack(
    message: "Lane #{lane} упал с ошибкой: #{exception}",
    success: false
  )
end

lane :deploy do
  match(type: 'appstore')
  gym(export_method: 'app-store')
  deliver
end

Блок error получает два аргумента: имя lane (symbol) и объект исключения. Внутри блока можно отправить уведомление в Slack, записать лог в файл или запустить альтернативный сценарий восстановления. Если error блок завершается успешно, Fastlane не считает сборку проваленной на уровне CI/CD.

Private lanes и переиспользование

Private lane — это lane, объявленный через private_lane вместо lane, который не отображается в списке доступных команд и не может быть запущен напрямую из терминала. Private lanes предназначены для инкапсуляции повторяющихся шагов, которые вызываются из нескольких публичных lanes.

Private lanes особенно полезны для сложных последовательностей действий, которые должны выполняться в строго определённом порядке. Например, private lane :setup_signing может вызываться из lanes :build_dev, :build_staging и :build_production с разными параметрами, но сама по себе не имеет смысла как отдельная команда.

# Private lanes для переиспользования
private_lane :setup_environment do |options|
  cocoapods(try_repo_update_on_error: true)
  match(type: options[:type], readonly: true)
  increment_build_number
end

lane :dev_build do
  setup_environment(type: 'development')
  gym(export_method: 'development')
end

lane :appstore_build do
  setup_environment(type: 'appstore')
  gym(export_method: 'app-store')
  deliver
end

Private lanes могут вызывать другие private lanes, образуя иерархию абстракций. Рекомендуется ограничивать глубину вложенности до 2–3 уровней для сохранения читаемости Fastfile. Документируйте каждый private lane комментарием с описанием его назначения и ожидаемых параметров.

Примеры lanes для iOS и Android

Рассмотрим практические примеры lanes для iOS и Android проектов. iOS lanes обычно используют scan для тестов, match для сертификатов, gym для сборки и pilot или deliver для доставки. Android lanes используют gradle для сборки, supply для публикации и firebase_test_lab для облачного тестирования.

// Lane для полного CI/CD iOS приложения
lane :ci_full_ios do
  scan(scheme: 'App', code_coverage: true)
  gym(scheme: 'App', export_method: 'app-store')
  pilot(distribute_external: true)
  slack(message: 'iOS CI/CD успешно завершён')
end

/* Lane для полного CI/CD Android приложения */
lane :ci_full_android do
  gradle(task: 'testReleaseUnitTest')
  gradle(task: 'bundleRelease')
  supply(track: 'internal')
end

Комбинируя lanes для iOS и Android, можно создать единый CI/CD процесс для кросс-платформенного приложения. Используйте платформенные блоки platform :ios и platform :android для группировки платформо-специфичных lanes, и вызывайте их из общего orchestrator lane, который управляет порядком выполнения.

Лучшие практики написания lanes

При написании lanes рекомендуется придерживаться набора практик, которые обеспечивают читаемость, поддерживаемость и надёжность сценариев. Первое правило — каждый lane должен выполнять одну задачу. Если lane делает слишком много, разбейте его на несколько lanes и private lanes.

Второе правило — именование lanes должно быть глаголом или глагольной фразой: build, deploy, test, upload_screenshots. Избегайте абстрактных имён типа process или do_all. Используйте нижние подчёркивания для разделения слов в имени lane.

Третье правило — обрабатывайте ошибки явно. Используйте UI.user_error! для понятных сообщений о проблемах. Не полагайтесь на стандартные сообщения Fastlane об ошибках — дайте разработчику контекст: "Не найден файл GoogleService-Info.plist — добавьте его в проект" вместо "File not found".

Четвёртое правило — тестируйте lanes локально перед запуском на CI/CD. Fastlane поддерживает dry-run режим через флаг --dry-run, который показывает, какие actions будут выполнены, без фактического запуска. Используйте fastlane run_test для изолированного тестирования отдельных lanes перед интеграцией.

Документирование lanes

Документирование каждого lane — важная практика для командной разработки. Fastlane поддерживает автоматическую генерацию документации из desc блока, размещённого перед объявлением lane. Текст desc отображается при запуске fastlane lanes и fastlane list, помогая разработчикам понять назначение каждого сценария без чтения исходного кода Fastfile.

Для документирования параметров используйте комментарии Ruby с описанием ожидаемых значений. Fastlane может генерировать README.md с полным списком lanes и их описанием через команду fastlane generate_docs, что удобно для адаптации новых членов команды к CI/CD процессам проекта.