Skip to main content
Wir veröffentlichen regelmäßig Aktualisierungen unserer Dokumentation, und die Übersetzung dieser Seite ist möglicherweise noch nicht abgeschlossen. Aktuelle Informationen findest du in der englischsprachigen Dokumentation.

Erstellen und Arbeiten mit CodeQL-Paketen

Du kannst CodeQL-Pakete verwenden, um CodeQL-Abfragen und -Bibliotheken zu erstellen, freizugeben, auszuführen oder Abhängigkeiten von diesen zu erstellen.

GitHub CodeQL wird nach der Installation auf Benutzerbasis lizenziert. Du kannst CodeQL nur für bestimmte Aufgaben unter den Lizenzeinschränkungen verwenden. Weitere Informationen findest du unter Informationen zur CodeQL-CLI.

Wenn du über eine GitHub Advanced Security-Lizenz verfügst, kannst du CodeQL für eine automatisierte Analyse sowie für Continuous Integration und Continuous Delivery verwenden. Weitere Informationen findest du unter Informationen zu GitHub Advanced Security.

Hinweis: Dieser Artikel wurde im Januar 2023 von der CodeQL-Dokumentationswebsite migriert.

Hinweis: Die CodeQL-Paketverwaltungsfunktionen (einschließlich der CodeQL-Pakete) sind derzeit als Betaversion verfügbar und können Änderungen unterliegen. Während der Betaversion sind CodeQL-Pakete nur mit GitHub-Paketen verfügbar – mit Container registry. Um diese Betafunktion zu verwenden, installiere die neueste Version des CodeQL CLI-Bundles aus https://github.com/github/codeql-action/releases.

Informationen zu CodeQL-Paketen und der CodeQL CLI

Hinweis: In diesem Artikel werden die Features beschrieben, die im CodeQL CLI 2.12.7-Bundle im ursprünglichen Release von GitHub Enterprise Server 3.7 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.

Mit CodeQL-Paketen und den Paketverwaltungsbefehlen in der CodeQL CLI kannst du deine benutzerdefinierten Abfragen veröffentlichen und in deine Codebaseanalyse integrieren.

Es gibt zwei Arten von CodeQL-Paketen: Abfragepakete und Bibliothekspakete.

  • Abfragepakete sind zum Ausführen konzipiert. Wenn ein Abfragepaket veröffentlicht wird, enthält es alle transitiven Abhängigkeiten und und einem Kompilierungscache. Dadurch wird konsistentes und effizientes Ausführen der Abfragen im Paket sichergestellt.
  • Bibliothekspakete sind zum Verwenden durch Abfragepakete oder andere Bibliothekspakete konzipiert und enthalten selbst keine Abfragen. Die Bibliotheken werden nicht , und beim Veröffentlichen des Pakets ist kein Kompilierungscache enthalten.

Du kannst den pack-Befehl in der CodeQL CLI verwenden, um CodeQL-Pakete zu erstellen, Abhängigkeiten zu Paketen hinzuzufügen und Abhängigkeiten zu installieren oder zu aktualisieren. Du kannst CodeQL-Pakete auch mithilfe des pack-Befehls veröffentlichen und herunterladen. Weitere Informationen findest du unter Veröffentlichen und Verwenden von CodeQL-Paketen.

Erstellen eines CodeQL-Pakets

Du kannst ein CodeQL-Paket erstellen, indem du den folgenden Befehl über den Check-Out-Stamm deines Projekts ausführst:

codeql pack init <scope>/<pack>

Dabei musst du Folgendes festlegen:

  • <scope>: Name der GitHub-Organisation oder des Benutzerkontos, in die bzw. das du veröffentlichen möchtest

  • <pack>: Name des Pakets, das du erstellst

Der Befehl codeql pack init erstellt die Verzeichnisstruktur und Konfigurationsdateien für ein CodeQL-Paket. Der Befehl erstellt standardmäßig ein Abfragepaket. Wenn du ein Bibliothekspaket erstellen möchtest, musst du die qlpack.yml-Datei bearbeiten, um die Datei explizit als Bibliothekspaket zu deklarieren, indem du die Eigenschaft library:true einschließt.

Ändern eines vorhandenen QL-Legacypakets zum Erstellen eines CodeQL-Pakets

Wenn du bereits über eine qlpack.yml-Datei verfügst, kannst du sie manuell bearbeiten, um sie in ein CodeQL-Paket zu konvertieren.

  1. Bearbeite die name-Eigenschaft so, dass sie dem Format <scope>/<name> entspricht, wobei <scope> der Name der GitHub-Organisation oder des Benutzerkontos ist, in die bzw. das du veröffentlichen möchtest.

  2. Schließe in der qlpack.yml-Datei eine version-Eigenschaft mit einem SemVer-Bezeichner sowie einen optionalen dependencies-Block ein.

  3. Migriere die Liste der Abhängigkeiten in libraryPathDependencies zum dependencies-Block. Gib den Versionsbereich für jede Abhängigkeit an. Wenn der Bereich nicht wichtig ist oder du dir der Kompatibilität nicht sicher bist, kannst du "\*" angeben. Dies legt fest, dass jede Version akzeptabel ist und standardmäßig die neueste Version verwendet wird, wenn du codeql pack install ausführst.

Weitere Informationen zu den Eigenschaften findest du unter Informationen zu CodeQL-Paketen.

Installieren von und Hinzufügen von Abhängigkeiten zu einem CodeQL-Paket

Du kannst CodeQL-Paketen mit dem codeql pack add-Befehl Abhängigkeiten hinzufügen. Du musst den Bereich, den Namen und (optional) einen kompatiblen Versionsbereich angeben.

codeql pack add <scope>/<name>@x.x.x <scope>/<other-name>

Wenn du keinen Versionsbereich angibst, wird die neueste Version hinzugefügt. Andernfalls wird die neueste Version hinzugefügt, die den angeforderten Bereich erfüllt.

Dieser Befehl aktualisiert die qlpack.yml-Datei mit den angeforderten Abhängigkeiten und lädt sie in den Paketcache herunter. Beachte, dass mit diesem Befehl die Datei neu formatiert wird und alle Kommentare entfernt werden.

Du kannst die qlpack.yml-Datei auch manuell bearbeiten, um Abhängigkeiten einzuschließen, und dann kannst du die Abhängigkeiten mit dem folgenden Befehl installieren:

codeql pack install

Mit diesem Befehl werden alle Abhängigkeiten in den freigegebenen Cache auf dem lokalen Datenträger heruntergeladen.

Hinweise:

  • Durch Ausführen der Befehle codeql pack add und codeql pack install wird die codeql-pack.lock.yml-Datei generiert oder aktualisiert. Diese Datei sollte in die Versionskontrolle eingecheckt werden. Die codeql-pack.lock.yml-Datei enthält die genauen Versionsnummern, die vom Paket verwendet werden. Weitere Informationen findest du unter Informationen zu codeql-pack.lock.yml-Dateien.

  • codeql pack install installiert Abhängigkeiten standardmäßig über die Container registry auf GitHub.com. Du kannst Abhängigkeiten über eine GitHub Enterprise Server-Container registry installieren, indem du eine qlconfig.yml-Datei erstellst. Weitere Informationen findest du unter Veröffentlichen und Verwenden von CodeQL-Paketen.