К содержимому

Конфигурация ревью GitLab MR ​

Настройки относятся к коннектору GitLab. ENV процесса имеет приоритет над локальным .env.

Подключение ​

ПеременнаяПо умолчаниюНазначение
GITLAB_BASE_URLrequiredБазовый URL GitLab
GITLAB_TOKENrequiredAPI-токен бота для публикации и управления ревьюерами. Не передаётся в песочницу
ORPHEUS_BASE_URLrequiredБазовый URL API Orpheus без /api/v1
ORPHEUS_API_KEYrequiredСервисный Bearer-ключ, разрешённый в Orpheus
ORPHEUS_WEB_BASE_URLORPHEUS_BASE_URLПубличный базовый URL веб-интерфейса для ссылок на сессии
WORKFLOWS_DIRworkflowsКаталог файлов workflow. Относительный путь считается от рабочего каталога процесса

Процесс и лимиты ​

ПеременнаяПо умолчаниюНазначение
APP_MODEprodprod или dev
LOG_LEVELerrorПодробность логов. Для диагностики работы используйте info
HTTP_TIMEOUT_SECONDS30Таймаут отдельного HTTP-запроса
POLL_INTERVAL_SECONDS30Интервал опроса GitLab
SHUTDOWN_TIMEOUT_SECONDS20Время на корректную остановку
RUN_TIMEOUT_SECONDS3600Таймаут запуска агента
HOOK_TIMEOUT_SECONDS300Таймаут хуков сессии
MAX_SESSION_REQUEST_BYTES1048576Максимальный размер файла workflow и собранного запроса создания сессии в байтах. Диапазон: 1–16777216
RECONCILE_WORKER_COUNT4Число одновременно обрабатываемых задач сверки состояния. Диапазон: 1–64
RECONCILE_QUEUE_CAPACITY128Размер очереди сверки состояния. Диапазон: 1–4096
MAX_CONCURRENT_REVIEWS4Число одновременных ревью. Диапазон: 1–1024. Также ограничено ресурсами Orpheus

Все интервалы *_SECONDS задаются положительным целым числом секунд. URL должны использовать HTTP или HTTPS и не содержать учётных данных, query-параметров или fragment. Для клонирования репозитория в песочнице требуется HTTPS.

Поля workflow ​

ПолеПо умолчаниюНазначение
idrequiredСтабильный уникальный ID workflow по шаблону [a-z0-9][a-z0-9_-]{0,79}
project_idsomittedНепустой список уникальных положительных ID проектов GitLab. Для общего workflow уберите поле
profilerequiredСуществующий профиль Orpheus
modelprofileНеобязательное переопределение модели
sandbox_templaterequiredСуществующий шаблон песочницы
servicesrequiredЯвный список уникальных кодов сервисов. Допустим []
languageomittedТег языка текста агента, например en, ru или pt-BR
notes.success / notes.failEnglish defaultsMarkdown-шаблоны комментариев об успехе и ошибке. Каждое поле необязательно

Под YAML обязателен непустой текст Markdown с правилами ревью. Он заменяет инструкции профиля. Примеры и маршрутизация.

Подстановки в комментариях ​

ПодстановкаЗначение
{{ .FindingsCount }}Число подтверждённых замечаний при успехе, включая ноль
{{ .Reason }}Публичное сообщение ошибки Orpheus, если оно есть, иначе разрешённая формулировка ошибки приложения. Markdown, HTML и упоминания экранируются.
{{ .SessionURL }}Публичная ссылка на сессию при ошибке или пустая строка, если ссылки нет

Публичное сообщение ошибки Orpheus может содержать исходную ошибку харнеса и видно читателям MR. Чтобы исключить текст ошибки, задайте свой notes.fail без {{ .Reason }}. Коннектор не добавляет исходные ошибки самого коннектора и логи хуков.

Функции, условия и другие выражения не поддерживаются. Явно пустое поле, неизвестная подстановка или шаблон, который может дать пустой комментарий, не допускаются. language не переводит шаблоны и причины ошибок.

Проверка файлов ​

Читаются обычные UTF-8-файлы .md в корне каталога. Подкаталоги, скрытые файлы, файлы с начальным # и другие расширения пропускаются. ID уникальны, маршруты проектов не пересекаются, общий workflow может быть только один. Файлы .md, которые не являются обычными файлами или не используют UTF-8, неизвестные поля, некорректный YAML, пустой каталог и превышение лимита размера файла останавливают весь запуск.

Workflows загружаются при старте. Как применить изменения.