Режим обновления определяется на этапе подключения сервиса. После подключения его также можно изменить через настройки подключения.
Сервис поддерживает три режима обновления артефактов документации:
manual — ручной режим, генерация выполняется исключительно по явному запросу пользователя.
scheduled — пересборка документации запускается автоматически в соответствии с заданным расписанием (ежедневно, еженедельно).
on_push — пересборка инициируется при каждом выполнении git push в default-ветку.
При выборе режима необходимо учитывать интенсивность разработки и требования к точности документации:
Режим on_push гарантирует, что документация всегда соответствует последнему состоянию кода в целевой ветке. Рекомендуется для проектов с высокой частотой релизов или требованием к нулевой задержке между изменениями кода и обновлением документации. Следует учитывать, что при частых коммитах данный режим приводит к пропорциональному увеличению числа пересборок и, соответственно, расходов на генерации.
Режим manual обеспечивает полный контроль над процессом и минимизирует затраты, так как генерация происходит только в момент явного запроса. Оптимален для стабильных проектов или этапов разработки, где актуальность документации не критична к каждому коммиту.
Режим scheduled представляет собой компромиссное решение, подходящее для регулярного обновления документации, например, в ночное время или по окончании рабочей недели.