Подключение ревью GitLab MR
Коннектор ревью GitLab MR запускает проверку, когда вы назначаете его бота ревьюером merge request. Он публикует замечания и итоговый комментарий в GitLab, затем снимает себя с ревью. Остальные ревьюеры остаются назначенными.
Коннектор опрашивает GitLab. Входящий webhook и публичный порт не нужны.
Подготовьте доступы
Потребуются работающий Orpheus, профиль для ревью и шаблон песочницы, в котором есть:
- Среда агента и инструменты для проверок из ваших правил ревью.
- Git, Python 3,
base64,gzipиsha256sum. glabс доступом на чтение данных MR и обсуждений.- Настроенная авторизация Git для клонирования и получения изменений приватных репозиториев по HTTPS. Коннектор использует HTTPS-адрес репозитория из GitLab.
Выдайте коннектору отдельный токен бота GitLab с доступом к API проектов, правами на публикацию обсуждений и комментариев и изменение ревьюеров. Добавьте бота в проекты, которые он должен проверять.
Передайте песочнице отдельные учётные данные только для чтения репозитория и API GitLab через сервис Orpheus или шаблон. GITLAB_TOKEN коннектора не копируется агенту. Выбор сервиса передаёт переменные в песочницу, но не настраивает авторизацию Git. Настройте и проверьте доступ Git по HTTPS в шаблоне.
GitLab должен быть доступен по HTTPS как из коннектора, так и из песочниц AgentBox. Проверьте clone, fetch и glab из сети песочниц, особенно если GitLab развёрнут в закрытой сети.
Например, добавьте такой сервис в orpheus.toml на API и worker:
[services.gitlab]
name = "Чтение GitLab"
description = "Чтение репозиториев, merge request и обсуждений."
env_from = ["GITLAB_HOST", "GITLAB_TOKEN"]Задайте эти переменные на worker Orpheus для инструментов песочницы. Здесь GITLAB_TOKEN должен содержать токен только для чтения, отдельный от токена бота коннектора. Настройте шаблон, чтобы Git также использовал эти данные для доступа по HTTPS.
В Compose-комплекте быстрого старта добавьте эти строки в существующий блок services.worker.environment, сохранив остальные строки:
GITLAB_HOST: ${GITLAB_HOST:?Set GITLAB_HOST}
GITLAB_TOKEN: ${GITLAB_READ_TOKEN:?Set a read-only GitLab token}Задайте GITLAB_HOST и GITLAB_READ_TOKEN в .env этого комплекта. Второе имя — отдельная переменная Compose для токена только для чтения. Примените изменения каталога и пересоздайте контейнер worker, чтобы он получил новое окружение.
Запустите коннектор
В клоне репозитория документации:
cd examples/gitlab-review
cp .env.example .envЗаполните настройки подключения в .env. Адреса должны быть доступны из контейнера коннектора. Укажите ключ API Orpheus, разрешённый в PUBLIC_API_KEYS. Для веб-интерфейса задайте адрес, который смогут открыть ревьюеры.
Отредактируйте workflows/review.md: замените ID проекта 123 своим ID из GitLab, выберите существующие профиль, шаблон и сервисы, запишите правила ревью. Имена review, gitlab-review и gitlab в примере должны соответствовать вашей конфигурации Orpheus.
docker compose config --quiet
docker compose pull
docker compose up -d
docker compose logs --tail=100 reviewЧтобы изменить другие настройки процесса, добавьте их в review.environment файла compose.yaml. Файл .env Compose подставляет только переменные, на которые ссылается конфигурация Compose.
Пример закрепляет опубликованный образ и монтирует workflows только для чтения. Образ коннектора опубликован для linux/amd64. Пример явно выбирает эту платформу. На ARM-машине Docker потребуется эмуляция amd64.
Проверьте ревью
- Откройте небольшой MR в выбранном проекте и назначьте бота ревьюером. Черновики MR тоже обрабатываются.
- Дождитесь следующего опроса, по умолчанию через 30 секунд.
- Посмотрите сессию и запуск в веб-интерфейсе Orpheus.
- Проверьте замечания и итоговый комментарий в GitLab. У завершённого ревью может быть ноль подтверждённых замечаний.
После завершения или ошибки назначьте бота снова для повторного ревью. Автоматическая проверка не одобряет и не сливает MR.