Як виглядає рецензія
Як heyGRC публікує результати перевірки у pull request: нейтральний статус Checks, вбудовані коментарі, один липкий підсумок та /heygrc на вимогу.
heyGRC - це рецензент відповідності, а не шлюз для злиття за замовчуванням. Під час кожного проходу рецензії він ґрунтує знайдені проблеми на рамках та контексті компанії, які ви налаштували.
Що з'являється у pull request
-
Статус Checks Запуск перевірки GitHub для heyGRC. За замовчуванням він є нейтральним (або успішним, якщо чисто): він інформує, але не блокує злиття PR. Ви можете зробити його обов'язковим у захисті гілки, якщо хочете шлюз.
-
Вбудовані коментарі Знайдені проблеми на важливих рядках: ідентифікатор контролю / обґрунтування, де зміна стосується зобов'язання. Вбудовані треди - це розв'язувані дискусії (див. Чи блокує heyGRC злиття?).
-
Один підсумок на PR (липкий) heyGRC зберігає один підсумок для pull request і оновлює його на місці під час пушу. Він не додає новий повний підсумок на кожен коміт. Коли з'являються нові знахідки, ви все одно отримуєте короткий сигнал рецензії; повторні запуски без змін залишаються непомітними у розмові. Згадка
/heygrc, яка не знаходить нічого нового, може підтвердити завершення реакцією на ваш коментар.
Коли запускаються рецензії
Частота рецензій налаштовується в консолі (за замовчуванням для організації, можливе перевизначення для кожного репозиторію):
| Режим | Поведінка |
|---|---|
auto | Рецензія при відкритті, повторному відкритті або пуші в PR |
auto_once | Рецензія лише при відкритті/повторному відкритті (не на кожен пуш) |
mention_only | Мовчання доти, доки хтось не прокоментує /heygrc |
За замовчуванням встановлено auto. Команди, які вже використовують галасливого бота для рецензії коду, часто починають з auto_once або mention_only.
На вимогу: /heygrc
Прокоментуйте /heygrc у PR, щоб запустити рецензію. Ви повинні бути власником, учасником або співробітником репозиторію, щоб сторонній коментатор не міг витратити ваші рецензії.
Великі pull request
Дуже великі PR можуть бути перевірені лише частково або позначені як часткові / пропущені з чітким нейтральним статусом перевірки, щоб робочий процес залишався безпечним. Надавайте перевагу меншим PR, якщо вам потрібне повне покриття.
Пов'язані матеріали
- Налаштування з вашим агентом (режими + встановлення)
- Використання з вашим рецензентом коду
- Чи блокує heyGRC злиття?