Ce contenu décrit la version la plus récente de CodeQL CLI. Pour plus d’informations sur cette version, consultez https://github.com/github/codeql-cli-binaries/releases.
Pour voir les détails des options disponibles pour cette commande dans une version antérieure, exécutez la commande avec l’option --help dans votre terminal.
Synopsis
codeql pack publish [--dry-run] [--threads=<num>] [--ram=<MB>] [--pack=<folder> | <package.tgz>] <options>... -- <dir>
codeql pack publish [--dry-run] [--threads=<num>] [--ram=<MB>] [--pack=<folder> | <package.tgz>] <options>... -- <dir>
Description
Publie un pack de bibliothèques QL dans un registre de packages.
Cette commande publie un pack dans un registre de packages. Avant la publication, le pack est d’abord compilé (si nécessaire) et mis en bundle.
Disponible depuis v2.6.0.
Options
Options principales
<dir>
Le répertoire racine du package ou de l’espace de travail est défini par défaut sur le répertoire de travail actif. Si ce paramètre pointe vers un répertoire contenant un fichier qlpack.yml, cette opération s’exécute uniquement sur ce package CodeQL. Si ce paramètre pointe vers un répertoire contenant un fichier codeql-workspace.yml, cette opération s’exécute sur tous les packages CodeQL de l’espace de travail.
-n, --[no-]dry-run
Affiche ce qui aurait été fait, mais ne publie pas réellement le package.
--no-keep
Supprime le bundle du pack après la publication.
-j, --threads=<num>
Utilise le nombre de threads spécifié pour compiler les requêtes.
La valeur par défaut est de 1. Vous pouvez passer 0 pour utiliser un thread par cœur sur la machine ou -N pour laisser N cœurs inutilisés (sauf si au moins un thread est toujours utilisé).
-M, --ram=<MB>
Définit la quantité totale de RAM que le compilateur doit être autorisé à utiliser.
--no-precompile
[Avancé] Évite de précompiler le cache de compilation dans le répertoire de sortie du pack. Cela réduit la taille du pack et le temps nécessaire à sa création, mais une compilation est requise avant que le pack ne puisse être exécuté. Uniquement intéressant pour les packs de requêtes.
--no-validate-extensions
[Avancé] Évitez de valider les extensions de données dans le cadre de l’étape de compilation.
Disponible depuis v2.13.3.
--no-overwrite
[Avancé] Évite de recompiler et de remplacer toute sortie compilée existante d’un appel précédent de cette commande.
-p, --pack=<folder> | <package.tgz>
[Avancé] Emplacement où mettre le tarball empaqueté. Si cette option se termine par .tgz, le tarball est créé avec ce nom. Sinon, un nouveau répertoire est créé au niveau du chemin spécifié et un ou plusieurs tarballs y sont créés. L’utilisation de .tgz n’est pas autorisée pour les espaces de travail.
--file=<package.tgz>
[Avancé] Charge package.tgz directement dans le registre de packages sans essayer de créer ou de mettre en bundle quoi que ce soit de nouveau.
--[no-]allow-prerelease
Autorise l’utilisation des packs avec des qualificateurs de préversion (par exemple, X.Y.Z-qualifier) à utiliser. Sans cet indicateur, les packs de préversion sont ignorés.
Disponible depuis v2.11.3.
Options pour configurer les packs CodeQL auxquels appliquer cette commande.
--format=<fmt>
Sélectionne le format de sortie text (par défaut) ou json.
--groups=[-]<group>[,[-]<group>...]
Liste les groupes de packs CodeQL à inclure ou exclure de cette opération. Un qlpack dans l’espace de travail donné est inclus si :
- Il se trouve dans au moins un des groupes cités sans signe moins (cette condition est automatiquement remplie en l’absence de groupe sans signe moins).
- Il ne se trouve dans aucun groupe listé avec un signe moins
Options pour configurer l’environnement de compilation
--search-path=<dir>[:<dir>...]
Liste des répertoires sous lesquels les packs QL peuvent être trouvés. Chaque répertoire peut être un pack QL (ou un bundle de packs contenant un fichier .codeqlmanifest.json à la racine) ou le parent immédiat d’un ou plusieurs de ces répertoires.
Si le chemin contient plusieurs répertoires, leur ordre définit la priorité entre eux : quand un nom de pack qui doit être résolu est mis en correspondance dans plusieurs arborescences de répertoires, celle donnée en premier gagne.
Le pointage de ce chemin vers une extraction du dépôt CodeQL open source devrait fonctionner lors de l’interrogation d’un des langages qui y résident.
Si vous avez extrait le dépôt CodeQL en tant que frère de la chaîne d’outils CodeQL décompressée, vous n’avez pas besoin de donner cette option ; ces répertoires frères sont toujours recherchés pour les packs QL qui ne peuvent pas être trouvés autrement. (Si cette valeur par défaut ne fonctionne pas, il est fortement recommandé de configurer --search-path une fois pour toutes dans un fichier de configuration par utilisateur).
(Remarque : Sur Windows, le séparateur de chemin est ;.)
--additional-packs=<dir>[:<dir>...]
Si cette liste de répertoires est donnée, des packs y sont recherchés avant ceux indiqués dans --search-path. L’ordre entre eux n’a pas d’importance ; il s’agit d’une erreur si un nom de pack est trouvé dans deux répertoires différents de cette liste.
Cette option est utile si vous développez temporairement une nouvelle version d’un pack qui apparaît aussi dans le chemin par défaut. En revanche, il n’est pas recommandé de remplacer cette option dans un fichier de configuration ; certaines actions internes ajoutent cette option à la volée, remplaçant toute valeur configurée.
(Remarque : Sur Windows, le séparateur de chemin est ;.)
--library-path=<dir>[:<dir>...]
[Avancé] Liste facultative des répertoires qui sont ajoutés au chemin de recherche d’importation brut pour les bibliothèques QL. Doit être utilisé seulement si vous utilisez des bibliothèques QL qui n’ont pas été empaquetées en tant que packs QL.
(Remarque : Sur Windows, le séparateur de chemin est ;.)
--dbscheme=<file>
[Avancé] Définit explicitement les requêtes de schéma de base de données à compiler. Ne doit être donné que par les appelants qui sont extrêmement sûrs de ce qu’ils font.
--compilation-cache=<dir>
[Avancé] Spécifie un répertoire supplémentaire à utiliser comme cache de compilation.
--no-default-compilation-cache
[Avancé] N’utilise pas de caches de compilation dans des emplacements standard, comme dans le pack QL contenant la requête ou dans le répertoire de la chaîne d’outils CodeQL.
Options pour configurer le gestionnaire de package CodeQL
--registries-auth-stdin
Permet de vous authentifier auprès des registres de conteneurs GitHub Enterprise Server en passant une liste de paires <registry_url>=<token> séparées par des virgules.
Par exemple, vous pouvez passer https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2
pour vous authentifier auprès de deux instances GitHub Enterprise Server.
Cela remplace les variables d’environnement CODEQL_REGISTRIES_AUTH et GITHUB_TOKEN. Si vous avez seulement besoin de vous authentifier auprès du registre de conteneurs github.com, vous pouvez vous authentifier en utilisant l’option plus simple --github-auth-stdin.
--github-auth-stdin
Permet de vous authentifier auprès du registre de conteneurs github.com en passant un jeton github.com GitHub Apps ou un jeton d’accès personnel via une entrée standard.
Pour vous authentifier auprès des registres de conteneurs GitHub Enterprise Server, passez --registries-auth-stdin ou utilisez la variable d’environnement CODEQL_REGISTRIES_AUTH.
Cela remplace la variable d’environnement GITHUB_TOKEN.
Options courantes
-h, --help
Affiche ce texte d’aide.
-J=<opt>
[Avancé] Donne une option à l’environnement JVM exécutant la commande.
(Attention, les options contenant des espaces ne sont pas gérées correctement.)
-v, --verbose
Augmente de façon incrémentielle le nombre de messages de progression affichés.
-q, --quiet
Diminue de façon incrémentielle le nombre de messages de progression affichés.
--verbosity=<level>
[Avancé] Définit explicitement le niveau de détail sur errors, warnings, progress, progress+, progress++ ou progress+++. Remplace -v et -q.
--logdir=<dir>
[Avancé] Écrit des journaux détaillés dans un ou plusieurs fichiers du répertoire donné, avec des noms générés qui incluent des horodatages et le nom de la sous-commande en cours d’exécution.
(Pour écrire un fichier journal avec un nom sur lequel vous avez un contrôle total, donnez plutôt --log-to-stderr et redirigez stderr comme vous le souhaitez.)
--common-caches=<dir>
[Avancé] Contrôle l’emplacement des données en cache sur le disque qui persisteront entre plusieurs exécutions de l’interface CLI, telles que les packs QL téléchargés et les plans de requête compilés. S’il n’est pas défini explicitement, il s’agit par défaut d’un répertoire nommé .codeql dans le répertoire de base de l’utilisateur. S’il n’existe pas déjà, il est créé.
Disponible depuis v2.15.2.