Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.

github upload-results

Отправляет ФАЙЛ SARIF в GitHub для сканирования кода.

GitHub CodeQL лицензируется для каждого пользователя после установки. CodeQL можно использовать только для определенных задач с ограничениями лицензии. Дополнительные сведения см. в разделе Сведения о CodeQL CLI.

Если у вас есть лицензия на GitHub Advanced Security, вы можете использовать CodeQL для автоматического анализа, непрерывной интеграции и непрерывной поставки. Дополнительные сведения см. в разделе Сведения о GitHub Advanced Security.

В этом материале описывается последний выпуск Интерфейса командной строки CodeQL. Дополнительные сведения об этом выпуске см. в разделе https://github.com/github/codeql-cli-binaries/releases.

Чтобы просмотреть сведения о параметрах, доступных для этой команды в более раннем выпуске, выполните команду с параметром в терминале --help .

Краткий обзор

Shell
codeql github upload-results --sarif=<file> [--github-auth-stdin] [--github-url=<url>] [--repository=<repository-name>] [--ref=<ref>] [--commit=<commit>] [--checkout-path=<path>] <options>...

Описание

Отправляет ФАЙЛ SARIF в GitHub для сканирования кода.

См. статью: https://docs.github.com/en/code-security/secure-coding/running-codeql-cli-in-your-ci-system#uploading-results-to-github

Необходимо задать маркер GitHub Apps или личный маркер доступа. В целях обеспечения безопасности рекомендуется установить --github-auth-stdin флаг и передать маркер команде через стандартные входные данные. Кроме того, GITHUB_TOKEN можно задать переменную среды.

Этот маркер должен иметь security_events область.

Основные параметры

-s, --sarif=<file>

[Обязательный] Путь к файлу SARIF для отправки. Это должны быть выходные данные анализа базы данных codeql (или результаты интерпретации базы данных codeql) с --format sarif-latest для отправки в github.com или GitHub AE или соответствующий поддерживаемый тег формата для экземпляров GitHub Enterprise Server (см https://docs.github.com/ . правильное значение для выпуска).

-r, --repository=<repository-name>

Владелец репозитория GitHub и имя (например, github/octocat) для использования в качестве конечной точки для отправки. Интерфейс командной строки попытается автоматически определить его из пути оформления заказа, если он опущен.

-f, --ref=<ref>

Имя проанализированного ссылки. Если это ссылка является фиксацией слияния запроса на вытягивание, используйте refs/pulls/1234/merge или refs/pulls/1234/head (в зависимости от того, соответствует ли эта фиксация HEAD или merge фиксации запроса на вытягивание). В противном случае это должна быть ветвь: refs/heads/branch-name. Если этот параметр опущен, интерфейс командной строки попытается автоматически заполнить его из текущей ветви пути оформления заказа, если она существует.

-c, --commit=<commit>

SHA для проанализированной фиксации. Если этот параметр опущен, cli попытается автоматически определить его из пути оформления заказа.

-p, --checkout-path=<path>

Путь к оформлению заказа. По умолчанию используется текущий рабочий каталог.

--merge

[Дополнительно] Разрешить указать несколько SARIF-файлов и объединить их в один файл перед отправкой. Это рекомендуется только для обратной совместимости. Для нового анализа рекомендуется отправить два отдельных ФАЙЛА SARIF с разными категориями. Этот параметр работает только в сочетании с SARIF-файлами, созданными CodeQL с SARIF версии 2.1.0 (это версия SARIF по умолчанию, используемая CodeQL).

--format=<fmt>

Выберите формат вывода. Можно выбрать:

text(по умолчанию): выведите URL-адрес для отслеживания состояния отправки SARIF.

json: выводит текст ответа запроса API отправки SARIF.

Дополнительные сведения см. по ссылке https://docs.github.com/en/rest/reference/code-scanning#upload-an-analysis-as-sarif-data

Параметры для настройки места отправки SARIF-файлов.

-a, --github-auth-stdin

Примите маркер GitHub Apps или личный маркер доступа через стандартные входные данные.

Это переопределяет переменную среды GITHUB_TOKEN.

-g, --github-url=<url>

URL-адрес используемого экземпляра GitHub. Если этот параметр опущен, cli попытается автоматически определить этот параметр из пути оформления заказа. Если это невозможно, по умолчанию используется значение https://github.com/

Общие параметры

-h, --help

Показать этот текст справки.

-J=<opt>

[Дополнительно] Предоставьте параметр виртуальной машине Java, запустив команду .

(Остерегайтесь, что параметры, содержащие пробелы, будут обрабатываться неправильно.)

-v, --verbose

Добавочное увеличение числа выводемых сообщений о ходе выполнения.

-q, --quiet

Постепенно уменьшайте количество выводемых сообщений о ходе выполнения.

--verbosity=<level>

[Дополнительно] Явно задайте уровень детализации для одной из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет -v и -q.

--logdir=<dir>

[Дополнительно] Запись подробных журналов в один или несколько файлов в заданном каталоге с созданными именами, включая метки времени и имя выполняющейся подкоманды.

(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого при необходимости предоставьте --log-to-stderr и перенаправьте stderr.)