Правила ревью кода в SourceCraft

SourceCraft позволяет гибко настраивать обязательные правила ревью кода, прежде чем код может быть добавлен в целевую ветку репозитория.

Если в репозитории включены правила ревью кода, SourceCraft анализирует подтверждения от ревьюеров на соответствие заданным правилам. Если подтверждений недостаточно, возможность выполнить слияние изменений из пул-реквеста с целевой веткой будет заблокирована.

Когда все подтверждения, заданные в правилах, получены, появляется возможность выполнить слияние.

Важно

Обойти правила ревью кода и выполнить принудительное слияние могут только пользователи с ролью Ответственный за репозиторий или ролью Администратор репозитория.

Конфигурация правил ревью кода задается для конкретного репозитория и хранится в файле .sourcecraft/review.yaml.

Важно

Скоро перестанет поддерживаться хранение конфигурации CI/CD, правил ревью кода и политик веток в едином файле .src.ci.yaml в корне репозитория. Используйте отдельные файлы .sourcecraft/ci.yaml, .sourcecraft/review.yaml и .sourcecraft/branches.yaml.

Подробнее о работе с правилами см. на странице Настроить правила ревью кода в репозитории SourceCraft.

Пример конфигурации

codereview: 
  need_ships: 1 # Требуемое количество одобрений от ревьюеров
  ignore_self_ship: false # Игнорировать одобрения от автора пул-реквеста
  ignore_non_reviewers_block: false # Игнорировать блокировку пул-реквеста от пользователей, не являющихся ревьюерами
  auto_assign: true # Автоматически назначать ревьюеров
  rules:
    - patterns:
        - '*'
      reviewers:
        usernames: 
          - "<имя_пользователя>" # Список ревьюеров
        assign: 1 # Количество ревьюеров, назначенных автоматически
        need_ships: 1 # Требуемое количество одобрений от ревьюеров
        ignore_self_ship: false # Игнорировать одобрения от автора пул-реквеста

Полную спецификацию файла .sourcecraft/review.yaml см. в репозитории templates в SourceCraft.

См. также

Предыдущая
Следующая