Skip to main content

github upload-results

Charge un fichier SARIF dans l’analyse du code GitHub.

Qui peut utiliser cette fonctionnalité ?

CodeQL est disponible pour les types de référentiels suivants :

Note

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

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

Description

Charge un fichier SARIF dans l’analyse du code GitHub.

Voir : Chargement des résultats d'analyse de CodeQL sur GitHub

Un jeton GitHub Apps ou un jeton d’accĂšs personnel doivent ĂȘtre dĂ©finis. Pour de bonnes pratiques en matiĂšre de sĂ©curitĂ©, nous vous recommandons de dĂ©finir l’indicateur --github-auth-stdin et de passer le jeton Ă  la commande par le biais d’une entrĂ©e standard. Vous pouvez Ă©galement dĂ©finir la variable d’environnement GITHUB_TOKEN.

Votre jeton doit avoir l’étendue security_events.

Options

Options principales

-s, --sarif=<file>

[Obligatoire] Chemin d’accĂšs au fichier SARIF Ă  utiliser. Il doit s’agir de la sortie de codeql database analyze (ou codeql database interpret-results) avec --format sarif-latest pour le chargement vers github.com ou l’étiquette de format prise en charge appropriĂ©e pour les instances GitHub Enterprise Server (voir Prise en charge de SARIF pour l’analyse du code pour les versions SARIF prises en charge par votre version).

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

PropriĂ©taire et nom du dĂ©pĂŽt GitHub (par exemple, github/octocat) Ă  utiliser comme point de terminaison pour le chargement. L’interface CLI tente de le dĂ©tecter automatiquement Ă  partir du chemin d’extraction s’il est omis.

-f, --ref=<ref>

Nom de la rĂ©fĂ©rence analysĂ©e. Si cette rĂ©fĂ©rence est un commit de fusion de demande de tirage (pull request), utilisez refs/pull/1234/merge ou refs/pull/1234/head (selon que ce commit correspond ou non au commit HEAD ou MERGE de la demande de tirage). Sinon, il doit s’agir d’une branche : refs/heads/nom-branche. En cas d’omission, l’interface CLI tente de remplir automatiquement cette valeur Ă  partir de la branche actuelle du chemin d’extraction, le cas Ă©chĂ©ant.

-c, --commit=<commit>

SHA du commit qui a Ă©tĂ© analysĂ©. S’il est omis, l’interface CLI tente de le dĂ©tecter automatiquement Ă  partir du chemin d’extraction.

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

Chemin de l’extraction. La valeur par dĂ©faut est le rĂ©pertoire de travail actif.

--merge

[AvancĂ©] Autorise la spĂ©cification de plusieurs fichiers SARIF et les fusionne en un seul fichier avant de les charger. Cela n’est recommandĂ© qu’à des fins de compatibilitĂ© descendante. Pour les nouvelles analyses, nous vous recommandons de charger deux fichiers SARIF distincts avec des catĂ©gories diffĂ©rentes. Cette option fonctionne uniquement conjointement avec les fichiers SARIF produits par CodeQL avec SARIF version 2.1.0 (il s’agit de la version par dĂ©faut de SARIF utilisĂ©e par CodeQL).

--no-wait-for-processing

Par dĂ©faut, l’interface CLI attend que GitHub traite le fichier SARIF pendant un maximum de 2 minutes, retournant un code de sortie non nul s’il y avait des erreurs lors du traitement des rĂ©sultats de l’analyse. Vous pouvez personnaliser la durĂ©e d’attente de l’interface CLI avec --wait-for-processing-timeout, ou dĂ©sactiver la fonctionnalitĂ© avec --no-wait-for-processing.

--wait-for-processing-timeout=<waitForProcessingTimeout>

DĂ©lai maximal pendant lequel l’interface CLI attendra que le fichier SARIF tĂ©lĂ©chargĂ© soit traitĂ© par GitHub, en secondes. La valeur par dĂ©faut est de 120 secondes (2 minutes). Cette option est valide uniquement quand --wait-for-processing est activĂ©.

--format=<fmt>

Sélectionne le format de sortie. Les options sont les suivantes :

text (par dĂ©faut)  : affiche l’URL du suivi de l’état du chargement SARIF.

json : affiche le corps de la rĂ©ponse de la demande d’API de chargement SARIF.

Voir aussi : Points de terminaison d’API REST pour l’analyse de codes

Options permettant de configurer l’emplacement de chargement des fichiers SARIF.

-a, --github-auth-stdin

Accepte un jeton GitHub Apps ou un jeton d’accĂšs personnel via une entrĂ©e standard.

Cela remplace la variable d’environnement GITHUB_TOKEN.

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

URL de l’instance GitHub Ă  utiliser. Si elle est omise, l’interface CLI tente de la dĂ©tecter automatiquement Ă  partir du chemin d’extraction et, si cela n’est pas possible, la valeur par dĂ©faut est https://github.com/

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.