Исправление результатов качества кода в невыполненной работы репозитория

Как Code Quality работает в ветви по умолчанию

Code Quality сканирует ветвь по умолчанию и сообщает результаты на страницах "Качество кода" на вкладке Security and quality репозитория. Он выполняет два типа анализа.

1. ** Стандартные выводы **: Code Quality используется CodeQL для выполнения детерминированной проверки на основе правил ветви по умолчанию. Поиск группируется по правилу и языку, помеченным по серьезности (ошибка, предупреждение, примечание), и каждый из них включает предлагаемый автофикс.

2. ** Выводы ИИ **: Code Quality использует анализ, основанный на искусственном интеллекте, для выявления проблем с качеством в файлах, недавно отправленных в ветвь по умолчанию, включая проблемы, которые могут не обнаруживать анализ на основе правил, например рекомендации, соглашения об именовании или рекомендации по проектированию.

Сведения о разрешении Выводы ИИсм. в разделе Исправление результатов качества кода в недавно объединенных файлах.

Разрешение стандартных выводов

Вы можете разрешить выводы по отдельности или назначить несколько выводов Copilot.

Разрешение единого поиска

1. Перейдите на Security and quality вкладку вашего репозитория.

2. Нажмите, чтобы развернуть Качество кода, затем нажмите Стандартные выводы.

3. Используйте фильтры панели мониторинга, чтобы сосредоточиться на результатах, скорее всего, повлиять на ваши оценки качества. Например, чтобы просмотреть все результаты уровня "Ошибка" для параметра "Надежность", задайте для фильтра значение:

   is:open category:reliability severity:error

4. Выводы группируются по правилу. Щелкните имя правила, которое нужно взять в подробное представление всех выводов для этого правила.

   

5. Нажмите Показать больше, затем ознакомьтесь с объяснением правила, рекомендуемым исправлением, примерами вспомогательного кода и ссылками.

1. Справа от отдельного поиска нажмите кнопку "Создать исправление".
2. Просмотрите дифф предлагаемого изменения. Если вы согласны с ним, нажмите кнопку "Открыть запрос на вытягивание".
3. В диалоговом окне "Фиксация автофикса в ветвь" выберите "Открыть запрос на вытягивание", а затем нажмите кнопку "Зафиксировать изменение".
4. Когда запрос на вытягивание автофикса готов к проверке, измените его состояние с "Черновик" на "Готово к проверке" и дождитесь передачи проверок CI перед слиянием.
5. Кроме того, если поиск не имеет значения или действия, нажмите кнопку "Закрыть". Например, вы можете закрыть вывод, который больше не поддерживается в устаревшем коде, является известным исключением для стандартов кодирования вашей команды или является ложным положительным результатом, который не представляет реальный риск качества.

Чтобы повысить удобство обслуживания или оценку надежности, необходимо разрешить каждое обнаружение на самом высоком уровне серьезности в настоящее время, влияющее на эту метрику. См . раздел AUTOTITLE.

Назначение нескольких выводов Copilot

Если у вас есть много результатов для правила и хотите эффективно устранить их, вы можете выбрать эти результаты массово и назначить их Copilot для исправления агента. Copilot откроет запрос на вытягивание с исправлениями для выбранных результатов.

Вам не нужна Copilot лицензия на использование этой функции, но владелец предприятия должен разрешить Code Quality вашей организации. См . раздел AUTOTITLE.

Для наилучших результатов начните с одного правила, которое имеет множество результатов с высоким уровнем серьезности. Это позволяет проверить качество автофиксов в согласованном наборе изменений перед расширением других правил.

1. Перейдите на Security and quality вкладку вашего репозитория.

2. Нажмите, чтобы развернуть Качество кода, затем нажмите Стандартные выводы.

3. Выберите результаты, которые нужно исправить. Вы можете выбрать до 25 выводов на страницу, одну страницу за раз.

4. Нажмите кнопку "Назначить".Copilot

   

5. Copilot откроет запрос на вытягивание с исправлениями для выбранных результатов. Внимательно просмотрите запрос на вытягивание перед слиянием.

Проверка того, обновлены ли оценки качества кода

После объединения запросов на вытягивание автофикса вернитесь в представление "Стандартные выводы", чтобы убедиться, что:

• Число выводов снизилось.
• Оценка доступности или надежности улучшилась, если вы разрешили все результаты на текущем минимальном уровне серьезности для этой метрики.

Дальнейшие действия

• Исправление результатов качества кода в недавно объединенных файлах