Первое ревью за пять минут¶

Результат¶

Вы зарегистрируетесь, подключите один проект GitLab и увидите комментарий ревью Threadory в настоящем merge request.

Что потребуется¶

роль admin или owner в проекте Threadory: подключать источник и менять настройки ревью могут только они. С более низкой ролью попросите администратора подключить GitLab и не передавайте свою сессию, токен или учётные данные коннектора. Комментарии ревью вы по-прежнему видите в GitLab;
проект GitLab (gitlab.com или self-managed), где вы можете создать токен и открыть merge request;
project access token или personal access token GitLab со scope api. Scope нужен, чтобы публиковать комментарий ревью и ставить webhook. Лучше отдельный токен для Threadory: GitLab покажет комментарий от имени пользователя токена;
для self-managed GitLab: инстанс должен достучаться до Threadory по HTTPS, потому что webhook отправляет сам сервер GitLab.

GitHub подключается другим путём; см. Ревью merge request.

Шаги¶

Зарегистрируйтесь. Создайте учётную запись и, если sign-up просит, откройте ссылку из письма с подтверждением.
Создайте workspace. Onboarding спросит название организации, затем название проекта. Нажмите Create workspace. Проект — единица, в которой живут подключения, знания и настройки одной команды.
Откройте Connectors. В sidebar выберите Connectors, найдите GitLab и нажмите Connect.
Следуйте guide в drawer. Он ведёт на нужные страницы GitLab. Если ваш GitLab self-managed, сначала заполните GitLab base URL — deep-ссылки следуют за ним.
Создайте токен в GitLab. Лучше project access token: в Settings → Access tokens проекта включите scope api и скопируйте токен. Personal access token (Open personal access tokens) тоже подходит, но он несёт ваш доступ ко всем проектам, до которых вы дотягиваетесь.
Заполните форму. Вставьте токен в Personal or project access token. В Project path or URL введите group/repository или полный URL проекта. Нажмите Connect GitLab.
Установите webhook. На следующем шаге нажмите Install webhook. Threadory создаёт webhook проекта в GitLab вашим токеном; URL и секрет копировать не нужно. URL webhook имеет вид <адрес Threadory API>/webhooks/<id подключения>/gitlab, и в GitLab он виден в Settings → Webhooks с включёнными событиями merge request, note, issue и push. Если выбрать Use polling for now, ревью работает, но приходит с задержкой до часа; webhook можно поставить позже из меню карточки коннектора.
Запустите первую синхронизацию. На странице Connectors нажмите Sync now на карточке GitLab. Дождитесь, пока в Activity синхронизация станет завершённой.
Откройте или обновите merge request. В GitLab откройте новый merge request или запушьте коммит в существующий. Возьмите изменение, затрагивающее реальный код, — чтобы ревью было что читать.

Как выглядит первый комментарий¶

В течение нескольких минут на merge request появится комментарий от пользователя GitLab, чей токен подключён. Форма зависит от изменения, но обычно в нём:

краткий разбор того, что делает изменение;
риски, которые видит ревью;
находки, каждая с файлом и строкой, серьёзностью и — когда исправление мелкое и точное — заменяющими строками в блоке suggestion;
раздел Linked context в конце, если Threadory связал merge request с тикетами или другими элементами.

Это один комментарий, а не набор тредов на diff. Если ответить под ним, Threadory может ответить в том же треде. Запушьте ещё коммит — ревью последует за ним: отметит, что вы исправили, и разберёт только изменившееся.

Как проверить результат¶

на карточке GitLab в Connectors webhook отмечен как установленный;
в Activity видна завершённая синхронизация и, после вашего merge request, запуск ревью;
комментарий есть на merge request в GitLab.

Где настроить¶

Откройте Settings → Review (нужна роль admin). Самые полезные переключатели на первую неделю:

Publish without approval — выключите, чтобы каждое ревью сначала шло в Approvals;
Confidence floor — поднимите, чтобы получать меньше, но увереннее;
Review guidelines — запишите обычным текстом правила вашей команды;
Review merge requests — главный выключатель.

Все настройки описаны в Ревью merge request.

Частые проблемы¶

Симптом	Вероятная причина	Что делать
Установка падает с ошибкой доступа	Неверны токен, base URL или путь проекта	Сверьте три поля с проектом GitLab
Шаг webhook падает	У токена нет scope `api` или GitLab не достучался до Threadory	Создайте токен с `api`; для self-managed GitLab разрешите исходящий HTTPS до Threadory и переустановите webhook из меню карточки
Нет комментария спустя несколько минут	Выключено ревью, нет webhook или ревью ждёт аппрува	См. Ревью merge request
Нет комментария после небольшого пуша	Ревью молчит, если новые изменения не стоят комментария	Это нормально; прежнее ревью остаётся в силе

Для ревью действуют лимиты Free-плана; тарифы — на threadory.ai.

Следующий шаг¶

Прочитайте Ревью merge request, чтобы узнать полное поведение, затем пройдите первый closed loop.