Настроить правила ревью кода в репозитории SourceCraft

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

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

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

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

Чтобы настроить правила ревью кода в репозитории:

Откройте главную страницу SourceCraft.
На вкладке Home перейдите в раздел Repositories.
Выберите репозиторий, в котором хотите настроить правила ревью кода.
Склонируйте репозиторий:
1. В правом верхнем углу нажмите кнопку Clone.
2. В зависимости от способа подключения скопируйте ссылку для клонирования репозитория.
3. В терминале выполните команду:
```
git clone <ссылка_для_клонирования_репозитория>
```
4. Перейдите в склонированный репозиторий:
```
cd <имя_репозитория>
```

Сформируйте файл конфигурации правила ревью кода .src.ci.yaml, например:

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 # Игнорировать одобрения от автора пул-реквеста

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

В блоке usernames укажите список пользователей, ревью от одного из которых должно быть обязательным в пул-реквесте.
Добавьте файл конфигурации правил ревью кода в индекс git, сделайте коммит и отправьте изменения в ветку main:
```
git add .src.ci.yaml
git commit -m "Added code review configuration"
git push -u origin main
```
Проверьте выполнение правил ревью кода:
1. Создайте тестовый пул-реквест.
2. В созданном пул-реквесте убедитесь, что:
  - На вкладке Overview отображается проверка Code Review в статусе In progress.
  - В блоке Reviewers отображается кто-то из ревьюеров, указанных в конфигурации правил ревью кода.
3. Дождитесь одобрения пул-реквеста.
4. Чтобы выполнить слияние с основной веткой, нажмите Merge pull request.
  
  Примечание
  
  Выполнять слияния могут пользователи с ролью Repository developer и выше.

См. также

Была ли статья полезна?

Настроить CI/CD

Управлять секретами