heyGRC Docs

Використання з вашим код-рев'юером

Як heyGRC працює поруч з Cursor Bugbot, CodeRabbit, Copilot code review або будь-яким іншим рев'юером.

heyGRC - це рев'юер відповідності вимогам, а не код-рев'юер. Він аналізує кожен пул-реквест на відповідність обраним вашою компанією фреймворкам (ISO 27001, SOC 2, GDPR та десятки інших), а також корпоративному контексту, і коли зміни зачіпають контроль, публікує ідентифікатор контролю, обґрунтування та статус перевірки.

Це означає, що він призначений для роботи поруч з тим, що вже перевіряє ваш код: Cursor Bugbot, CodeRabbit, GitHub Copilot code review, сканер безпеки чи людські рев'юери. Той самий пул-реквест, інше питання. heyGRC не робить заяв щодо того, що виявляють або пропускають ці інструменти; він просто відповідає на інше питання.

Як два рев'ю співіснують у PR

  • Кожен додаток публікує власний рев'ю та власну перевірку. heyGRC публікує один консолідований рев'ю за прохід (знахідки вбудовуються в один рев'ю), а також нейтральний статус Checks.
  • Жодному інструменту не потрібно знати про існування іншого. Немає інтеграцій для налаштування та вимог до порядку.
  • Знахідки надходять різними шляхами: знахідки коду виправляються в дифі; знахідки відповідності іноді виходять за його межі (оновлення політики, збір доказів). Сприймайте знахідки heyGRC як окрему невелику чергу.

Зниження загального обсягу

Налаштуйте частоту роботи heyGRC у консолі (на рівні організації або перевизначте для кожного репозиторію); див. Налаштування з вашим агентом, крок 4:

РежимПоведінка
autoПеревіряє кожен PR при відкритті, повторному відкритті або надсиланні змін.
auto_onceПеревіряє лише при відкритті / повторному відкритті, не на кожному коміті.
mention_onlyМовчить, доки хтось не прокоментує /heygrc у PR.

Команди, які вже використовують ботів для код-рев'ю, зазвичай починають з auto_once або mention_only, а потім посилюють налаштування, коли сигнал заслуговує на довіру.

Блокування проти інформування

За замовчуванням перевірка heyGRC є нейтральною: вона інформує, а рішення про злиття залишається за вашою командою. Щоб зробити її блокуючою, позначте перевірку heyGRC як обов'язкову в захисті гілок GitHub, так само, як і будь-яку іншу CI-задачу.

Налаштування

Встановіть з github.com/apps/heygrc, потім налаштуйте фреймворки та корпоративний контекст за допомогою одного API-виклику; найшвидший шлях - Налаштування з вашим агентом.

On this page