Skip to main content

Добавление пакета

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

Кто эту функцию можно использовать?

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

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

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

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

Краткие сведения

Shell
codeql pack add <options>... -- <scope/name[@range]>...

Description

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

Эта команда изменяет файл qlpack.yml текущего пакета. Форматирование и комментарии будут удалены.

Доступно с момента v2.6.0.

Параметры

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

<scope/name[@range]>...

[Обязательный] Область, имя и необязательный диапазон версий пакета для добавления в список зависимостей.

Если диапазон версий не указан или диапазон версий указан как "последняя", то последняя версия пакета загружается, а зависимость добавляется в qlpack.yml, которая разрешает любую версию, совместимую с скачаемой версией.

Если указана отдельная версия, скачиваемая версия пакета, и зависимость добавляется в qlpack.yml, которая разрешает любую версию, совместимую с указанной версией.

Если указан диапазон версий, последняя версия пакета, удовлетворяющая указанному диапазону, загружается, а зависимость добавляется в qlpack.yml с указанным диапазоном версий.

--dir=<dir>

Корневой каталог пакета.

--registries-auth-stdin

Проверка подлинности в реестрах контейнеров GitHub Enterprise Server путем передачи <registry_url>=<token> разделенного запятыми списка пар.

Например, можно передать https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 для проверки подлинности на двух экземплярах GitHub Enterprise Server.

При этом переопределяются переменные среды маркера токена CODEQL_И_AUTH и GITHUB_. Если вам нужно выполнить проверку подлинности только в реестре контейнеров github.com, можно вместо этого выполнить проверку подлинности с помощью более --github-auth-stdin простого параметра.

--github-auth-stdin

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

Чтобы пройти проверку подлинности в реестрах контейнеров GitHub Enterprise Server, передайте --registries-auth-stdin или используйте переменную среды AUTH CODEQL_REGISTRIES_.

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

--[no-]allow-prerelease

Разрешить использовать пакеты с квалификаторами предварительной версии (например, X.Y.Z-qualifier). Без этого флага пакеты предварительного выпуска будут игнорироваться.

Доступно с момента v2.11.3.

Распространенные параметры

-h, --help

Отображение этого текста справки.

-J=<opt>

[Дополнительно] Укажите параметр JVM, выполняя команду.

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

-v, --verbose

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

-q, --quiet

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

--verbosity=<level>

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

--logdir=<dir>

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

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

--common-caches=<dir>

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

Доступно с момента v2.15.2.