Сведения о результатах функции code scanning для запросов на вытягивание
В репозиториях можно настроить code scanning как проверку запросов на вытягивание, при этом code scanning будет проверять код в запросах на вытягивание. По умолчанию проверка осуществляется только для запросов на вытягивание, предназначенных для ветви по умолчанию, но при необходимости это поведение можно настроить в GitHub Actions или в сторонней системе непрерывной интеграции и поставки (CI/CD). Если слияние изменений приведет к созданию новых оповещений code scanning в целевой ветви, оповещения передаются в следующих местах.
- Проверьте результаты в запросе на вытягивание .
- Вкладка Измененные файлы запроса на вытягивание.
Если у вас есть разрешение на запись для репозитория, все существующие оповещения code scanning можно увидеть на вкладке Безопасность . Сведения об оповещениях репозитория см. в разделе Управление оповещениями проверки кода для репозитория.
В репозиториях, где code scanning настроено для сканирования при каждой отправке кода, code scanning также сопоставляет результаты с открытыми запросами на вытягивание и добавляет оповещения в виде заметок в тех же местах, что и другие проверки запросов на вытягивание. Дополнительные сведения см. в разделе Настройка сканирования кода.
Если ваш запрос на вытягивание нацелен на защищенную ветвь, которая использует code scanning, а владелец репозитория настроил необходимые проверки состояния, проверка "Code scanning результаты" должна пройти перед слиянием запроса на вытягивание. Дополнительные сведения см. в разделе Сведения о защищенных ветвях.
Сведения об использовании функции code scanning в качестве проверки запроса на вытягивание
Существует множество вариантов настройки code scanning в качестве проверки запроса на вытягивание, поэтому точная конфигурация каждого репозитория будет отличаться, а некоторые из них будут иметь несколько проверок.
Проверка результатов Code scanning
Для всех конфигураций code scanning проверка, содержащая результаты code scanning, имеет следующий формат: Code scanning results. Результаты для каждого используемого средства анализа отображаются отдельно. Все новые оповещения, вызванные изменениями в запросе на вытягивание, отображаются в виде заметок.
Чтобы просмотреть полный набор оповещений для анализируемой ветви, щелкните Просмотреть все оповещения ветви. Откроется полное представление оповещений, в котором можно отфильтровать все оповещения в ветви по типу, серьезности, тегу и т. д. Дополнительные сведения см. в разделе Управление оповещениями проверки кода для репозитория.
Сбои при проверке результатов Code scanning
Если проверка результатов code scanning выявит какие-либо проблемы с уровнем серьезности error, critical или high, она завершается сбоем, а в ее результатах отображается ошибка. Если все найденные функцией code scanning результаты имеют более низкий уровень серьезности, оповещения обрабатываются как предупреждения или заметки, а проверка завершается успешно.
Вы можете переопределить поведение по умолчанию в параметрах репозитория, указав уровень серьезности и условия уровней безопасности, которые приведут к сбою проверки запроса на вытягивание. Дополнительные сведения см. в разделе Настройка сканирования кода.
Другие проверки code scanning
В разных конфигурациях могут быть настроены дополнительные проверки, выполняемые для запросов на вытягивание с помощью функции code scanning. Как правило, это рабочие процессы, которые анализируют код или отправляют результаты функции code scanning. Эти проверки могут выполняться для устранения неполадок при возникновении проблем с анализом.
Например, если репозиторий использует Рабочий процесс анализа CodeQL, перед выполнением проверки результатов выполняется проверка CodeQL / Analyze (LANGUAGE). Проверка "Анализ" может завершиться сбоем при возникновении проблем с конфигурацией, а также если запрос на вытягивание нарушает работу сборки для языка, который этой проверке требуется скомпилировать (например, C/C++, C# или Java).
Как и в случае с другими проверками запросов на вытягивание, вы можете просмотреть полные сведения о сбое проверки на вкладке Проверки . Дополнительные сведения о настройке и устранении неполадок см. в разделе Настройка сканирования кода или Устранение неполадок рабочего процесса CodeQL.
Просмотр оповещения по запросу на вытягивание
Все оповещения code scanning по запросу на вытягивание можно просмотреть на вкладке Измененные файлы. Каждое оповещение отображается в виде заметки в строках кода, из которых оно было активировано. В заметке отображается уровень серьезности оповещения.
Если у вас есть разрешение на запись для репозитория, в некоторых заметках будут содержаться ссылки с дополнительным контекстом для оповещения. В приведенном выше примере из анализа CodeQL с помощью ссылки Предоставленное пользователем значение можно просмотреть, на каком этапе в поток данных поступают ненадежные данные (источник данных). В этом случае также можно просмотреть полный путь из источника в использующий данные код (приемник) с помощью кнопки Показать пути. Так можно проверить, являются ли данные ненадежными или анализу не удалось распознать шаг очистки данных между источником и приемником. Дополнительные сведения об анализе потока данных с помощью CodeQL см. в разделе Сведения об анализе потока данных.
Дополнительные сведения об оповещении пользователь с разрешением на запись может просмотреть по ссылке Показать подробности, представленной в заметке. С ее помощью можно в полном объеме просмотреть контекст и метаданные, выводимые средством в представлении оповещения. В приведенном ниже примере можно увидеть теги, показывающие уровень серьезности, тип и соответствующие распространенные уязвимости (CWE) для проблемы. В этом представлении также показана фиксация, в связи с которой возникла проблема.
Состояние и сведения на странице оповещений отражают состояние оповещения только в ветви репозитория по умолчанию, даже если это оповещение существует в других ветвях. Состояние оповещения в ветвях, не являющихся ветвью по умолчанию, отображается в разделе Затронутые ветви в правой части страницы оповещений. Если оповещение не существует в ветви по умолчанию, его состояние оповещения отображается как "в запросе на вытягивание" или "в ветки" и выделяется серым цветом.
В подробном представлении оповещения некоторые средства code scanning, например анализ CodeQL, также выводят описание проблемы и ссылку Показать больше для просмотра указаний по исправлению кода.
Исправление оповещения по запросу на вытягивание
Любой пользователь с доступом на отправку к запросу на вытягивание может исправить оповещение code scanning, указанное в этом запросе. После фиксации изменений в запросе на вытягивание будут заново выполнены его проверки. Если в результате внесения изменений проблема исправлена, оповещение закрывается, а заметка удаляется.
Отклонение оповещения по запросу на вытягивание
Оповещение также можно закрыть, отклонив его. Если вы не считаете, что оповещение требуется исправлять, его можно отклонить. Например, когда есть ошибка в коде, который используется только для тестирования, или когда усилия по исправлению ошибки больше потенциального преимущества улучшения кода. Если у вас есть разрешение на запись для репозитория, в аннотациях в коде и в сводке оповещений будет доступна кнопка Отклонить. При нажатии кнопки Отклонить вам будет предложено выбрать причину закрытия оповещения.
Если вы закрываете оповещение CodeQL как ложное срабатывание, например, поскольку в коде используется библиотека очистки, которая не поддерживается, рассмотрите возможность добавления CodeQL в репозиторий и улучшение анализа. Дополнительные сведения о CodeQL см. в разделе "Участие в улучшении CodeQL."
Дополнительные сведения об удалении оповещений см. в разделе "Управление оповещениями проверки кода для репозитория".