Примечание.
GitHub Code Quality в настоящее время находится в public preview и может быть изменен. Во время public preview, Code Quality не будут оплачиваться, хотя Code Quality сканирование займет GitHub Actions минут.
Введение
Вы можете заблокировать запросы на вытягивание, которые не соответствуют стандартам качества кода, добавив правило ветви Требовать результаты качества кода в набор правил и указав требуемый уровень серьезности. Если запрос на вытягивание не достигает этого порогового значения, его нельзя объединить.
Предпосылки
- Code Quality включено. См. раздел AUTOTITLE
- Код на поддерживаемом языке. Смотрите раздел Поддерживаемые языки.
Примечание.
Пороговое значение будет иметь значение только в том случае, если репозиторий содержит код на одном или нескольких поддерживаемых языках, см. AUTOTITLE.
Подтверждение Code Quality успешно выполняется в запросах на вытягивание
Прежде чем добавлять или обновлять набор правил, чтобы включить пороговое значение для Code Quality, убедитесь, что рабочий процесс Качество кода выполняется и передает результаты в запросы на вытягивание. В противном случае набор правил может заблокировать слияние всех запросов на вытягивание.
- Откройте недавний запрос на вытягивание и прокрутите до сводки «Проверки» в нижней части запроса на вытягивание.
- Убедитесь, что проверка "CodeQL - Качество кода" выполнена успешно и сообщила о ее статусе.
Дополнительные сведения см. в разделе Анализ качества кода на основе CodeQL.
Добавление или обновление набора правил для включения Code Quality
- Перейдите на вкладку «Настройки» вашего репозитория.
- На левой боковой панели, в разделе "Код и автоматизация", разверните Правила, затем нажмите Rulessets.
- Если у вас еще нет набора правил для защиты ветви по умолчанию, разверните узел Новый набор правил и нажмите кнопку Новый набор правил ветви. Либо откройте существующий набор правил для ветви по умолчанию и перейдите к шагу 5.
- Если вы создаете новый набор правил:
- Определите имя для набора правил.
- Установите для параметра "Статус принудительного применения" значение "Активно".
- В разделе "Целевые ветви" добавьте цель "Включить ветвь по умолчанию".
- В разделе "Правила ветвей" включите параметр "Требовать результаты качества кода".
- Задайте значение "Серьезность", чтобы определить самую низкую серьезность результатов качества кода, которые должны быть разрешены, прежде чем запрос на вытягивание может быть объединен с ветвью по умолчанию. Рассмотрим пример.
- Установите "Errors", чтобы блокировать запросы pull с неустраненными ошибками качества кода, которые объединяются.
- Установите параметр "Предупреждения и выше", чтобы блокировать запросы на вытягивание с неустраненными предупреждениями о качестве кода или ошибками при объединении.
- Установите "Примечания и выше", чтобы блокировать запросы на вытягивание с неразрешенными замечаниями о качестве кода, предупреждениями или ошибками при объединении.
- Установите "Все", чтобы блокировать запросы на вытягивание с любыми неразрешенными результатами качества кода, которые объединяются.
- После завершения определения или редактирования набора правил нажмите кнопку Создать или Сохранить изменения.
Дальнейшие шаги
Узнайте, как GitHub Code Quality работает с запросами на вытягивание, чтобы предотвратить попадание проблем с качеством кода в ветку по умолчанию. См . раздел AUTOTITLE.