Skip to main content

О статусе инструмента

Страница состояния средства предоставляет видимость состояния и производительности инструментов code scanning в вашем репозитории.

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

Пользователи с доступом на запись

Code scanning доступен для следующих типов репозитория:

  • Общедоступные репозитории для GitHub.com
  • Репозитории, принадлежащие организации, на GitHub Team, GitHub Enterprise Cloud или GitHub Enterprise Server, с включённым GitHub Code Security .

Что такое Страница состояния средства?

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

Примечание.

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

Индикаторы состояния инструментов

Страница состояния средства отображает один из трёх статусов:

  • Все конфигурации работают: все инструменты работают как ожидается
  • Некоторые конфигурации требуют внимания: некоторые инструменты имеют предупреждения или некритические проблемы
  • Некоторые конфигурации не работают: один или несколько инструментов имеют критические ошибки

Какая информация доступна

Для всех code scanning инструментов

  • Состояние конфигурации и состояние
  • Планирование сканирования
  • Первое и самое последнее время сканирования
  • Правила, используемые в сканировании

Для интегрированных инструментов, таких как CodeQL

В дополнение к вышеуказанной информации, Страница состояния средства для интегрированных инструментов содержит следующие детали:

  • Проценты покрытия файлов по языкам программирования
  • Детали конфигурации для каждого типа настройки
  • Сообщения об ошибках
  • Скачиваемые CSV-отчёты по анализируемым файлам
  • Списки используемых правил и количество оповещений для скачивания

Как CodeQL определяет сканированные файлы

CodeQL сообщает о отсканированном файле, если некоторые строки кода в этом файле были обработаны.

Интерпретируемые языки

  • Настройка по умолчанию: Отсканированные файлы включают все исходные коды для языков данных, которые variables.product.prodname_codeql %} может анализировать
  • Расширенная настройка: вы можете использовать paths и paths-ignore определять, какие файлы сканировать. См . раздел AUTOTITLE.

Компилированные языки

Страница состояния средства отчётывает файлы перед запуском автосборки или ручной сборки. Файлы, созданные в процессе сборки, не отображаются. См . раздел AUTOTITLE.

Расчёт покрытия

Проценты покрытия файлов учитывают любые файлы, исключённые свойствами paths конфигурации и paths-ignore конфигурации.

Понимание процентов покрытия файлов

Используйте проценты покрытия файлов для отладки и улучшения вашего анализа:

  • Высокий процент: Code scanning работает как ожидается для этого языка
  • Низкий процент: Изучить диагностические результаты. См. раздел AUTOTITLE
  • Ноль процентов: у вас может быть код на языках, которые сейчас не анализируются. Обновите свою конфигурацию, чтобы включить эти языки. См. раздел AUTOTITLE

Примечание.

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

Функции устранения неполадок

Страница состояния средства помогает вам устранять проблемы через:

  • Сообщения об ошибках: объясняет, почему инструменты не работают как ожидается с предложенными действиями
  • Данные о покрытии файлов: показывают, какие файлы и языки анализируются
  • Детали конфигурации: отображается информация о каждом запуске анализа
  • Скачиваемые отчёты: предоставляет CSV-отчёты с подробной информацией о файлах и правилах

Дополнительные материалы