О качестве кода на GitHub

Используйте GitHub Code Quality для обозначения проблем с качеством кода в запросах на вытягивание и сканировании репозитория, применяйте Copilotавтоисправлениях на основе } и применяйте стандарты с помощью наборов правил.

Кто может использовать эту функцию?

GitHub Team или GitHub Enterprise Cloud

В этой статье

Примечание.

GitHub Code Quality в настоящее время находится в public preview и может быть изменен. Во время public preview, Code Quality не будут оплачиваться, хотя Code Quality сканирование займет GitHub Actions минут.

Обзор

GitHub Code Quality помогает вам убедиться, что ваша кодовая база надежна, удобна в обслуживании и эффективна. Независимо от того, создаете ли вы новую функцию, сокращаете технический долг или создаете отчеты о работоспособности репозитория, Code Quality предоставляет полезные аналитические сведения и автоматические исправления, чтобы вы могли эффективно улучшать и поддерживать работоспособность кода репозитория.

Ключевые функции и преимущества

С помощью Code Quality вы можете:

  • Выявляйте риски и возможности для качества кода в запросах на вытягивание и с помощью сканирования репозитория.
  • Просматривайте понятные объяснения выводов и применяйте автоисправления variables.product.prodname_copilot_short %помощью данных одним щелчком мыши.
  • Используйте панели мониторинга репозитория для отслеживания показателей надежности и удобства обслуживания, выявления областей, требующих внимания, и определения приоритетов для исправления.
  •         **Отслеживайте панели управления организации**, чтобы быстро понять состояние кода ваших репозиториев и определить, какие репозитории стоит исследовать дальше.
  • Настройте наборы правил для запросов на вытягивание, чтобы обеспечить соблюдение стандартов качества кода и заблокировать изменения, которые не соответствуют вашим критериям.
  • Легко назначьте работы по исправлению Агент кодирования Copilot, если у вас есть лицензия Copilot.

Доступность и стоимость использования

GitHub Code Quality доступен для репозиториев, принадлежащих организации, на тарифных планах GitHub Team и GitHub Enterprise Cloud.

GitHub Code Quality не будут оплачиваться в общедоступной предварительной версии. Однако сканирование Code Quality займет GitHub Actions минут. См . раздел AUTOTITLE.

Примечание.

  • Вам не нужна лицензия Copilot или Code Security для использования Code Quality или применения Copilot-powered autofixs.

Поддерживаемые языки

Code Quality выполняет анализ на основе правил следующих языков с использованием CodeQL:

  • C#
  • Go
  • Ява
  • JavaScript
  • Питон
  • Руби
  • Машинописный текст

Code Quality также выполняет анализ на базе ИИ, результаты которого отображаются отдельно на панели управления репозитория "Выводы ИИ". В отличие от анализа CodeQL на основе правил, который сканирует всю кодовую базу и pull-запросы, этот анализ на базе ИИ анализирует только файлы, недавно отправленные в стандартную ветку, и может выявлять проблемы на языках, выходящих за рамки вышеуказанных. Дополнительные сведения см. в разделе Ответственное использование GitHub Code Quality.

Где появятся результаты?

Как только вы включите Code Quality для репозитория, вы увидите CodeQL сканирование для:

  • Каждый новый запрос на вытягивание, открытый в ветке по умолчанию
  • Все существующие запросы на вытягивание в ветвь по умолчанию при их обновлении, что запускает новый запуск тестов CI
  • Вся кодовая база в ветке по умолчанию на время и дату, указанные на странице настроек "Качество кода"

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

Результаты запроса на вытягивание

Когда CodeQL обнаруживает проблемы на основе правил в запросах на вытягивание, вы увидите комментарии от github-code-quality[бот]. Там, где это возможно, каждый комментарий будет включать Автофикс второго пилота предложение о том, как решить проблему. См . раздел AUTOTITLE.

Результаты ветви по умолчанию

Результаты Code Quality на ветке по умолчанию отображаются на страницах "Качество кода" на вкладке " Безопасность " для репозитория:

  •         **Стандартные выводы** показывает результаты анализа качества CodeQL. См [. раздел AUTOTITLE](/code-security/code-quality/tutorials/improve-your-codebase).

  •         **Выводы ИИ** показывает результаты анализа с помощью искусственного интеллекта файлов, которые последние были отправлены в ветку по умолчанию. См [. раздел AUTOTITLE](/code-security/code-quality/tutorials/improve-recent-merges).

Информация о сканировании

Каждый анализ CodeQL будет использовать GitHub Actions минут и может быть просмотрен на вкладке "Действия " репозитория как запуск динамического рабочего процесса "Качество кода".

Дальнейшие шаги

  •         **Для вашего репозитория:** Включите Code Quality, чтобы начать генерировать результаты. См [. раздел AUTOTITLE](/code-security/how-tos/maintain-quality-code/enable-code-quality).

  •         **Для вашего предприятия:** Убедитесь, что репозитории в вашем предприятии могут включать Code Quality. См [. раздел AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise).