# GitHub-Upload-Ergebnisse Lädt eine SARIF-Datei in die GitHub-Codeüberprüfung hoch. ## Zusammenfassung ```shell copy codeql github upload-results --sarif= [--github-auth-stdin] [--github-url=] [--repository=] [--ref=] [--commit=] [--checkout-path=] ... ``` ## Description Lädt eine SARIF-Datei in die GitHub-Codeüberprüfung hoch. Weitere Informationen finden Sie unter [Hochladen von CodeQL-Analyseergebnissen in GitHub](/de/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github). Es muss ein GitHub Apps-Token oder ein persönliches Zugriffstoken festgelegt werden. Die bewährte Methode für die Sicherheit besteht darin, das Flag `--github-auth-stdin` festzulegen und das Token über die Standardeingabe an den Befehl zu übergeben. Alternativ kann die Umgebungsvariable `GITHUB_TOKEN` festgelegt werden. Dieses Token muss als Bereich `security_events` verwenden. ## Options ### Primäre Optionen #### `-s, --sarif=` ``` \[Erforderlich] Pfad zu den zu verwendenden SARIF-Dateien. Dies sollte die Ausgabe von [codeql database analyze](/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze) (oder [codeql database interpret-results](/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results)) mit `--format sarif-latest` für den Upload auf github.com oder das entsprechende unterstützte Formattag für GitHub Enterprise Server-Instanzen sein (Siehe [AUTOTITLE](/enterprise-server@latest/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning) für SARIF-Version, die von Ihrem Release unterstützt werden). ``` #### `-r, --repository=` Besitzer und Name des GitHub-Repositorys (z. B. *github/octocat*), das als Endpunkt für den Upload verwendet werden soll. Die CLI versucht, diese Informationen automatisch aus dem Auscheckpfad zu ermitteln, wenn keine Angabe erfolgt. #### `-f, --ref=` Name der Referenz, die analysiert wurde. Wenn diese Referenz ein Pull-Request-Merge-Commit ist, verwende *refs/pull/1234/merge* oder *refs/pull/1234/head* (je nachdem, ob dieser Commit dem HEAD- oder MERGE-Commit des PR entspricht). Andernfalls sollte dies ein Branch sein: *refs/heads/Branchname*. Wenn keine Angabe erfolgt, versucht die CLI, diese Informationen automatisch aus dem aktuellen Branch des Auscheckpfads aufzufüllen, sofern dieser vorhanden ist. #### `-c, --commit=` SHA des analysierten Commits. Wenn keine Angabe erfolgt, versucht die CLI, diese Informationen automatisch aus dem Auscheckpfad zu ermitteln. #### `-p, --checkout-path=` Auscheckpfad. Die Standardeinstellung ist das aktuelle Arbeitsverzeichnis. #### `--merge` ``` \[Erweitert] Die Möglichkeit bieten, mehr als eine SARIF-Datei anzugeben und diese vor dem Hochladen zu einer einzigen Datei zusammenzufassen. Dies wird nur zur Abwärtskompatibilität empfohlen. Für neue Analysen wird empfohlen, zwei separate SARIF-Dateien mit unterschiedlichen Kategorien hochzuladen. Diese Option funktioniert nur in Verbindung mit SARIF-Dateien, die von CodeQL mit SARIF Version 2.1.0 erstellt wurden (dies ist die Standardversion von SARIF, die von CodeQL verwendet wird). ``` #### `--no-wait-for-processing` Standardmäßig wartet die CLI, bis GitHub die SARIF-Datei für maximal 2 Minuten verarbeitet und einen Nicht-Null-Exit-Code zurückgibt, wenn während der Verarbeitung der Analyseergebnisse Fehler aufgetreten sind. Du kannst mit `--wait-for-processing-timeout` anpassen, wie lange das CLI warten soll, oder die Funktion mit `--no-wait-for-processing` deaktivieren. #### `--wait-for-processing-timeout=` Die maximale Zeit, die die CLI wartet, bis die hochgeladene SARIF-Datei von GitHub verarbeitet wird, in Sekunden. Der Standardwert beträgt 120 Sekunden (2 Minuten). Diese Option ist nur gültig, wenn `--wait-for-processing` auf festgelegt ist. #### `--format=` Legt ein Ausgabeformat fest. Verfügbare Optionen: ``` `text` _(Standard)_: Druckt die URL aus, um den Status des SARIF-Uploads zu verfolgen. `json`: Druckt den Response Body der SARIF-Upload-API-Anfrage. ``` Weitere Informationen finden Sie auch unter [REST-API-Endpunkte für die Codeüberprüfung](/de/rest/code-scanning/code-scanning). ### Optionen zum Konfigurieren des Speicherorts für die hochgeladenen SARIF-Dateien. #### `-a, --github-auth-stdin` Akzeptiert ein GitHub Apps-Token oder ein persönliches Zugriffstoken über die Standardeingabe. Dadurch wird die GITHUB\_TOKEN-Umgebungsvariable überschrieben. #### `-g, --github-url=` URL der zu verwendenden GitHub-Instanz. Wenn nicht angegeben, versucht die CLI, diese automatisch über den Check-Out-Pfad zu ermitteln. Wenn dies nicht möglich ist, wird diese standardmäßig auf gesetzt. ### Allgemeine Optionen #### `-h, --help` Zeigt diesen Hilfetext an. #### `-J=` ``` \[Erweitert] Dient zum Angeben einer Option für die JVM-Instanz, die den Befehl ausführt. ``` (Beachte, dass Optionen, die Leerzeichen enthalten, nicht ordnungsgemäß verarbeitet werden.) #### `-v, --verbose` Ermöglicht die inkrementelle Erhöhung der Anzahl ausgegebener Statusmeldungen. #### `-q, --quiet` Ermöglicht die inkrementelle Verringerung der Anzahl ausgegebener Statusmeldungen. #### `--verbosity=` ``` \[Erweitert] Dient zum expliziten Festlegen des Ausführlichkeitsgrads auf „errors“, „warnings“, „progress“, „progress+“, „progress++“ oder „progress+++“. Überschreibt `-v` und `-q`: ``` #### `--logdir=` ``` \[Erweitert] Ermöglicht das Schreiben detaillierter Protokolle in eine oder mehrere Dateien im angegebenen Verzeichnis mit generierten Namen, die Zeitstempel und den Namen des ausgeführten Unterbefehls enthalten. ``` (Um eine Protokolldatei mit einem Namen zu schreiben, über den du die volle Kontrolle hast, gib stattdessen `--log-to-stderr` an, und leite stderr wie gewünscht um.) #### `--common-caches=` ``` \[Erweitert] Steuert den Speicherort zwischengespeicherter Daten auf dem Datenträger, der zwischen mehreren Ausführungsvorgängen der CLI beibehalten wird, z. B. heruntergeladene QL-Pakete und kompilierte Abfragepläne. Wenn dies nicht explizit festgelegt ist, wird dieses Verzeichnis standardmäßig auf ein Verzeichnis mit dem Namen `.codeql` festgelegt, das sich im Startverzeichnis des Benutzer. Es wird erstellt, wenn es noch nicht vorhanden ist. ``` Verfügbar seit `v2.15.2`.