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

добавление диагностики

[Экспериментальный][Сантехника] Добавьте часть диагностических сведений.

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

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

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

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

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

Shell
codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...

Описание

[Экспериментальная] [Сантехника] Добавление части диагностических сведений.

Доступно начиная с v2.12.6.

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

--markdown-message=<markdownMessage>

Сообщение для диагностики в формате Markdown с GitHub.

--plaintext-message=<plaintextMessage>

Сообщение для диагностики в виде обычного текста. Этот параметр следует использовать только при заполнении сообщения Markdown параметром --markdown-message нецелесообразно.

--severity=<severity>

Серьезность диагностики. Может иметь значение "error", "warning" или "note".

Ссылки справки, относящиеся к диагностике.

--attributes-json=<attributesJson>

Структурированные метаданные, относящиеся к диагностике.

Параметры, указывающие место для сохранения диагностических сведений

Необходимо указать именно один из этих вариантов.

--diagnostic-dir=<diagnosticDir>

Каталог, в который следует добавить диагностику.

Параметры, указывающие, где может отображаться диагностическое сообщение

--ready-for-status-page

Укажите, что диагностика подходит для отображения на странице состояния.

--ready-for-cli-summary-table

Укажите, что диагностика подходит для отображения в сводной таблице диагностика, напечатанной с помощью таких команд, как database analyze.

Параметры, описывающие источник диагностики

--source-id=<id>

[Обязательный] Идентификатор для источника этой диагностики.

--source-name=<name>

[Обязательно] Понятное для человека описание источника этой диагностики.

--extractor-name=<extractorName>

Имя средства извлечения CodeQL, если эта диагностика была создана с помощью средства извлечения CodeQL.

Параметры, описывающие расположение диагностики

--file-path=<file>

Путь к файлу, к которому применяется диагностика, относительно корневого каталога источника.

--start-line=<startLine>

Номер строки из 1 (включительно), с которого начинается расположение диагностики.

--start-column=<startColumn>

Номер столбца из 1 (включительно), с которого начинается расположение диагностики.

--end-line=<endLine>

Номер строки из 1 (включительно), на котором заканчивается расположение диагностики.

--end-column=<endColumn>

Номер столбца из 1 (включительно), на котором заканчивается расположение диагностики.

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

-h, --help

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

-J=<opt>

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

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

-v, --verbose

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

-q, --quiet

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

--verbosity=<level>

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

--logdir=<dir>

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

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