Правила и проекты для ревью
Каждый Markdown-файл в корне WORKFLOWS_DIR задаёт workflow. YAML в начале файла выбирает проекты и настройки выполнения. Текст Markdown содержит инструкции для ревью.
Выберите проекты
---
id: backend-review
project_ids: [123, 456]
profile: review
sandbox_template: gitlab-review
services: [gitlab]
language: ru
---
# Правила ревью
Проверь корректность, контроль доступа и изменения публичных контрактов.
Прочитай инструкции проекта и выполни подходящие доступные проверки.
Сообщай об исправимых проблемах этого изменения со ссылками на файлы и строки.
Объясни, какие обязательные проверки не удалось завершить.Замените ID и имена в примере своими. Поле services обязательно. Укажите services: [], если шаблон уже предоставляет все необходимые доступы. Сервисы не выбираются неявно.
Поле project_ids задаёт правила для конкретных проектов. Уберите его в одном workflow, чтобы охватить остальные проекты, доступные боту. Явный маршрут имеет приоритет над общим. Проект может входить только в один явный маршрут.
Общий workflow необязателен. Если для назначенного MR нет подходящего workflow, коннектор публикует сообщение о пропуске, снимает только себя с ревью и не запускает агента.
Запишите правила
Текст Markdown заменяет инструкции профиля. Включите все необходимые правила ревью: обязательные проверки, источники требований и порядок оценки прежних замечаний. Контекст MR и инструкции по подготовке результатов добавляет коннектор.
Агент анализирует выбранный diff MR в подготовленном репозитории. За публикацию в GitLab отвечает коннектор. Не поручайте агенту публиковать комментарии, одобрять MR или переключаться на новую ревизию ветки.
Поле language задаёт язык текста агента. Оно не переводит сообщения коннектора об успехе, ошибке или пропуске. Стандартные служебные шаблоны написаны на английском. Причина ошибки может включать публичное сообщение Orpheus.
Встроенные инструкции результата требуют имена файлов замечаний вида F-0001.md — не меньше четырёх цифр, точное совпадение с ID замечания. Пользовательские правила должны сохранять эти имена при подтверждении или отклонении замечания. Описательные суффиксы добавлять нельзя.
Настройте итоговые сообщения
Добавьте notes в YAML в начале файла:
notes:
success: "✅ Ревью завершено. Подтверждено замечаний: {{ .FindingsCount }}."
fail: |
⚠️ Не удалось завершить ревью: {{ .Reason }}.
Сессия Orpheus: {{ .SessionURL }}Шаблон заменяет весь видимый комментарий, включая ссылки и эмодзи. Пишите его на нужном языке. Поддерживаются только три описанных подстановки. Вокруг необязательных значений, например ссылки на сессию, оставляйте осмысленный текст. Сообщение о пропуске проекта без workflow остаётся на английском.
Примените изменения
После редактирования файлов перезапустите коннектор. В примере Compose:
docker compose restart review
docker compose logs --tail=100 reviewНекорректные файлы, повторяющиеся ID, пересечение маршрутов и пустой каталог workflows не дают запуститься всему коннектору. См. правила проверки.
Принятые ревью сохраняют исходные настройки и сообщения, даже если workflow изменён или удалён. Правка файлов не запускает новое ревью. Чтобы применить новые правила, назначьте бота снова после завершения текущей проверки.