Skip to main content

Enterprise Server 3.16 ist derzeit als Release Candidate verfügbar.

Erstellen von CodeQL CLI-Datenbankpaketen

Du kannst ein Datenbankpaket mit CodeQL-Problembehandlungsinformationen erstellen.

Wer kann dieses Feature verwenden?

CodeQL ist für die folgenden Repositorytypen verfügbar:

Warning

CodeQL CLI-Datenbankpakete enthalten eine Kopie des Quellcodes, der von CodeQL analysiert wird. Daher wird empfohlen, diese Pakete nur für Personen freizugeben, die für den Zugriff auf diesen Quellcode autorisiert sind.

Informationen zum Erstellen von CodeQL CLI-Datenbankpaketen

Note

In diesem Artikel werden die Features beschrieben, die im CodeQL CLI 2.20.3-Bundle im ursprünglichen Release von GitHub Enterprise Server 3.16 enthalten sind.

Wenn dein Websiteadministrator deine CodeQL CLI auf eine neuere Version aktualisiert hat, findest du in der GitHub Enterprise Cloud-Version dieses Artikels Informationen über die neuesten Features.

Der Befehl CodeQL CLI des Datenbankpakets kann verwendet werden, um ein wiederverwendbares Archiv einer CodeQL-Datenbank zu erstellen.

Eine Kopie eines Datenbankpakets kann verwendet werden, um Informationen zur Problembehandlung an deine Teammitglieder oder an den GitHub-Support freizugeben.

Die folgende CodeQL CLI-Befehlssyntax wird vorgeschlagen, wenn du ein Datenbankpaket zu Problembehandlungszwecken erstellst:

Note

Der Beispielbefehl database bundle erfordert CodeQL CLI Version 2.17.6 oder höher.

codeql database bundle --output=codeql-debug-artifacts.zip --include-diagnostics --include-logs --include-results -- <dir>

Für diesen Befehl muss der Pfad zum Verzeichnis <dir> sein, in dem die CodeQL-Datenbank erstellt wurde.

Die erfolgreiche Befehlsausführung erstellt eine ZIP-Datei namens codeql-debug-artifacts.zip, die Problembehandlungsinformationen von CodeQL enthält. Diese Datei ist das Datenbankpaket.

Bei diesem Befehl wird davon ausgegangen, dass das Befehlszeilenargument --log-dir für die Befehle database create und database analyze nicht verwendet wurde. Wenn dieses Befehlszeilenargument verwendet wird, sind die von diesen Befehlen erstellten Protokolldateien nicht im Datenbankpaket enthalten.

Erhöhen der Ausführlichkeit für database create und database analyze

Wenn die Befehle database create und database analyze für Problembehandlungszwecke nicht detailliert genug sind, kannst du deren Ausführlichkeit erhöhen.

Beide Befehle unterstützen das --verbosity-Befehlszeilenargument, das vor dem Erstellen eines Datenbankpakets auf progress++ festgelegt werden kann.