Сведения о Страница состояния средства
В Страница состояния средства отображаются полезные сведения обо всех средствах code scanning. Если code scanning не работает должным образом, Страница состояния средства является хорошей отправной точкой для отладки проблем.
С помощью Страница состояния средства можно увидеть, насколько хорошо средства сканирования кода работают для репозитория, когда файлы в репозитории были впервые проверены и недавно сканированы, а также когда запланированы проверки. Для интегрированных средств, таких как CodeQL, вы также можете просмотреть более подробные сведения, включая процент отсканированных файлов и конкретные сообщения об ошибках.
Вы также можете просмотреть правила, с которыми код проверялся в каждой конфигурации средства code scanning, и скачать сводку результатов.
Примечание: В Страница состояния средства показано, как средства работают на уровне репозитория, а не на уровне организации. Состояние средства отображается только для ветвь по умолчанию репозитория, для которого настроено это средство.
Просмотр Страница состояния средства для репозитория
Страница оповещений сканирования кода для каждого репозитория содержит баннер инструментов с сводкой по работоспособности анализа сканирования кода и доступом к Страница состояния средства для изучения настройки.
- На GitHub.com перейдите на главную страницу репозитория. 1. Под именем репозитория щелкните Безопасность. Если вкладка "Безопасность" не отображается, выберите раскрывающееся меню и выберите пункт Безопасность.
- Щелкните Состояние инструмента на баннере инструментов.
Использование Страница состояния средства
В Страница состояния средства вы увидите сводку по одному средству, выделенную на боковой панели. Вы можете использовать боковую панель для просмотра сводок по различным средствам.
Для интегрированных средств, таких как CodeQL, можно увидеть процент всех файлов, недавно отсканированных в репозитории, упорядоченных по языку программирования. Сведения о том, какие файлы считаются просканированными CodeQL, см. в разделе Определение отсканированных файлов в CodeQL. Вы также можете скачать подробные языковые отчеты в формате CSV. Дополнительные сведения см. в разделе Сведения о скачивании проанализированных файлов.
Три возможных состояния инструментов: все конфигурации работают, некоторые конфигурации требуют внимания, а некоторые конфигурации не работают.
Доступ к подробным сведениям об инструментах
Если вы хотите просмотреть более подробные сведения о текущем средстве, можно выбрать конкретную настройку в разделе "Типы установки".
В разделе "Конфигурации" в левой части экрана отображаются сведения о каждом анализе, выполняемом этим типом установки, и соответствующие сообщения об ошибках. Чтобы просмотреть подробные сведения о последнем выполнении анализа, выберите конфигурацию на боковой панели. Вы можете скачать сведения о том, какие именно правила выполнялись в этом сканировании кода и сколько оповещений было найдено каждым правилом. Дополнительные сведения см. в разделе Скачивание списков используемых правил.
В этом представлении также будут отображаться сообщения об ошибках. Дополнительные сведения см. в разделе Отладка с помощью страницы состояния средства.
Определение отсканированных файлов в CodeQL
CodeQL сообщает о том, что файл проверяется, если были обработаны некоторые строки кода в этом файле. Если вы используете стандартную конфигурацию действия CodeQL, отсканированные файлы, отображаемые в Страница состояния средства, будут содержать файлы исходного кода для всех языков, которые может анализировать CodeQL. Если вы используете расширенную установку, при необходимости можно определить, какие файлы для интерпретируемых языков должны проверяться с помощью paths свойств конфигурации и paths-ignore . Дополнительные сведения см. в разделах О проверке кода с помощью CodeQL и Настройка сканирования кода.
Для скомпилированных языков Страница состояния средства сообщает о файлах, которые присутствовали перед запуском автоматической сборки или любыми шагами сборки вручную. Это означает, что файлы, созданные в процессе сборки, не отображаются в Страница состояния средства. Дополнительные сведения см. в разделе Настройка рабочего процесса CodeQL для скомпилированных языков.
Страница состояния средства вычисляет процент файлов, которые были проверены CodeQL для каждого языка, поддерживаемого CodeQL. Этот процент учитывает все файлы, исключенные свойствами конфигурации paths и paths-ignore .
Скачивание сведений об проанализированных файлах
Для интегрированных средств, таких как CodeQL, подробные отчеты можно скачать из Страница состояния средства в формате CSV. Отобразится следующее:
- Какая конфигурация использовалась для сканирования каждого файла.
- Путь к файлу.
- Язык программирования файла.
- Указывает, был ли файл успешно извлечен.
Чтобы скачать отчет, выберите интересующее вас средство. Затем в правом верхнем углу страницы нажмите кнопку .
Скачивание списков используемых правил
Вы можете скачать список правил, которые проверяет code scanning, в формате CSV. Отобразится следующее:
- Используемая конфигурация.
- Источник правила.
- Идентификатор SARIF.
- Количество обнаруженных оповещений.
Чтобы скачать отчет, выберите нужную конфигурацию. Затем щелкните в правом верхнем углу страницы и выберите Скачать список используемых правил.
Удаление конфигураций
Вы можете удалить устаревшие, повторяющиеся или нежелательные конфигурации для ветвь по умолчанию репозитория.
Чтобы удалить конфигурацию, выберите конфигурацию, которую нужно удалить. Затем щелкните в правом верхнем углу страницы и выберите Удалить конфигурацию. После прочтения предупреждения об оповещениях нажмите кнопку Удалить , чтобы подтвердить удаление.
Примечание: Страница состояния средства можно использовать только для удаления конфигураций для ветвь по умолчанию репозитория. Сведения об удалении конфигураций из ветвей, отличных от ветвей по умолчанию, см. в разделе Управление оповещениями проверки кода для репозитория.
Отладка с помощью Страница состояния средства
Если вы видите проблему с анализом на странице оповещений code scanning, можно использовать Страница состояния средства, чтобы определить проблему. Для интегрированных средств в разделе с подробными сведениями можно просмотреть конкретные сообщения об ошибках, связанные с конкретными инструментами code scanning. Эти сообщения об ошибках содержат сведения о том, почему средство может не работать должным образом, и действия, которые можно предпринять. Дополнительные сведения о том, как получить доступ к этому разделу Страница состояния средства, см. в разделе Доступ к подробным сведениям об инструментах.
Для интегрированных средств, таких как CodeQL, можно также использовать сведения об объеме файлов для улучшения анализа. Для каждого языка, отображаемого в Страница состояния средства:
- Если язык имеет высокий процент отсканированных данных, это показывает, что сканирование кода сканирует этот язык должным образом.
- Если язык имеет низкий процент отсканированных данных, вы можете изучить диагностические данные, созданные CodeQL для этого языка: дополнительные сведения см. в разделе Устранение неполадок вашей расширенной установки для CodeQL.
- Если процент отсканированных языков равен нулю, возможно, исходный код в репозитории написан на языках, поддерживаемых CodeQL, но в настоящее время не анализируется с помощью CodeQL. В этом случае может потребоваться обновить настройку, чтобы начать анализ этих дополнительных языков. Дополнительные сведения см. в разделе Настройка сканирования кода.
Примечание: Если вы настроили CodeQL с помощью расширенной установки, а затем настроили настройку по умолчанию в том же репозитории, Страница состояния средства будет отображать только настройку по умолчанию.
Дополнительные сведения см. в разделах Устранение неполадок при настройке CodeQL по умолчанию и Устранение неполадок вашей расширенной установки для CodeQL.