Примечание.
Администратор сайта должен включить code scanning , прежде чем использовать эту функцию. Дополнительные сведения см. в разделе Настройка сканирования кода для вашего устройства.
Возможно, вы не сможете включить или отключить code scanning , если владелец предприятия установил GitHub Code Security политику на уровне предприятия. Дополнительные сведения см. в разделе Применение политик безопасности кода и анализа для вашего предприятия.
Что такое Страница состояния средства?
Отображает Страница состояния средства сведения обо всех code scanning средствах и является хорошей отправной точкой для отладки проблем, когда code scanning они не работают должным образом.
Примечание.
Отображается Страница состояния средства состояние средства на уровне репозитория только для ветви по умолчанию, а не на уровне организации.
Индикаторы состояния инструментов
Отображается Страница состояния средства одно из трех состояний:
- Все конфигурации работают: все инструменты работают как ожидается
- Некоторые конфигурации требуют внимания: некоторые инструменты имеют предупреждения или некритические проблемы
- Некоторые конфигурации не работают: один или несколько инструментов имеют критические ошибки
Какая информация доступна
Для всех code scanning средств
- Состояние конфигурации и состояние
- Планирование сканирования
- Первое и самое последнее время сканирования
- Правила, используемые в сканировании
Для интегрированных инструментов, таких как CodeQL
Помимо приведенных выше сведений, Страница состояния средства интегрированные средства предоставляют следующие сведения:
- Проценты покрытия файлов по языкам программирования
- Детали конфигурации для каждого типа настройки
- Сообщения об ошибках
- Скачиваемые CSV-отчёты по анализируемым файлам
- Списки используемых правил и количество оповещений для скачивания
Определение CodeQL сканированных файлов
CodeQL сообщает файл как сканированный, если были обработаны некоторые строки кода в этом файле.
Интерпретируемые языки
- Настройка по умолчанию: сканированные файлы включают все файлы исходного кода для языков CodeQL , которые могут анализировать
- Расширенная настройка: вы можете использовать
pathsиpaths-ignoreопределять, какие файлы сканировать. См . раздел AUTOTITLE.
Компилированные языки
Файлы отчетов, представленные Страница состояния средства перед выполнением автоматической сборки или ручной сборки. Файлы, созданные в процессе сборки, не отображаются. См . раздел AUTOTITLE.
Расчёт покрытия
Проценты покрытия файлов учитывают любые файлы, исключённые свойствами paths конфигурации и paths-ignore конфигурации.
Понимание процентов покрытия файлов
Используйте проценты покрытия файлов для отладки и улучшения вашего анализа:
- Высокий процент: Code scanning работает должным образом для этого языка
- Низкий процент: Изучить диагностические результаты. См. раздел AUTOTITLE
- Ноль процентов: у вас может быть код на языках, которые сейчас не анализируются. Обновите свою конфигурацию, чтобы включить эти языки. См. раздел AUTOTITLE
Примечание.
Если настроить расширенную настройку и настройку по умолчанию, Страница состояния средства отображается только настройка по умолчанию.
Функции устранения неполадок
Это Страница состояния средства поможет устранить неполадки с помощью следующих действий.
- Сообщения об ошибках: объясняет, почему инструменты не работают как ожидается с предложенными действиями
- Данные о покрытии файлов: показывают, какие файлы и языки анализируются
- Детали конфигурации: отображается информация о каждом запуске анализа
- Скачиваемые отчёты: предоставляет CSV-отчёты с подробной информацией о файлах и правилах