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