Konfigurieren des erweiterten Setups für das Codescanning mit CodeQL im großen Stil

Du kannst ein Skript verwenden, um das erweiterte Setup für das code scanning für eine bestimmte Gruppe von Repositorys in deiner Organisation zu konfigurieren.

Wer kann dieses Feature verwenden?

Code scanning ist für alle öffentlichen Repositorys auf GitHub.com verfügbar. Zur Verwendung von code scanning in einem privaten organisationseigenen Repository musst du über eine Lizenz für GitHub Advanced Security verfügen. Weitere Informationen findest du unter Informationen zu GitHub Advanced Security.

In diesem Artikel

Informationen zum Aktivieren des erweiterten Setups für das code scanning mit CodeQL im großen Stil

Wenn Sie ein hochgradig anpassbares code scanning-Setup für viele Repositorys in Ihrer Organisation konfigurieren müssen oder wenn die Repositorys in Ihrer Organisation für das Standardsetup nicht geeignet sind, können Sie das code scanning mit dem erweiterten Setup im großen Stil konfigurieren.

Um das erweiterte Setup in mehreren Repositorys zu aktivieren, können Sie ein Massenkonfigurationsskript schreiben. Um das Skript erfolgreich auszuführen, müssen die GitHub Actions für die Organisation oder das Unternehmen aktiviert werden.

Wenn du für viele Repositorys in deiner Organisation keine präzise Kontrolle über die code scanning-Konfiguration benötigst, kannst du das code scanning mit dem Standardsetup schnell und einfach konfigurieren. Weitere Informationen findest du unter Konfigurieren des Standardsetups für das Codescanning im großen Stil.

Verwenden eines Skripts zum Aktivieren von advanced setup

Für Repositorys, die nicht für das Standardsetup geeignet sind, können Sie ein Massenkonfigurationsskript verwenden, um das erweiterte Setup für mehrere Repositorys zu aktivieren.

  1. Identifiziere eine Gruppe von Repositorys, die mit derselben code scanning-Konfiguration analysiert werden können. Dazu zählen beispielsweise alle Repositorys, die Java-Artefakte mithilfe der Produktionsumgebung erstellen.
  2. Erstelle und teste einen GitHub Actions-Workflow, um die CodeQL-Aktion mit der entsprechenden Konfiguration aufzurufen. Weitere Informationen findest du auf Konfigurieren des erweiterten Setups für das Codescanning.
  3. Verwenden Sie eines der Beispielskripts, um ein benutzerdefiniertes Skript zu erstellen, um den Workflow jedem Repository in der Gruppe hinzuzufügen.

Erweitern der CodeQL-Abdeckung mit Modellpaketen

Hinweis: Die CodeQL-Paketverwaltungsfunktionen, einschließlich CodeQL-Paketen, befinden sich derzeit in der Betaphase und können noch geändert werden. Bei der Betaversion werden Modellpakete nur von der Java/Kotlin und C#-Analyse unterstützt.

Wenn Ihre Codebasis von einer Bibliothek oder einem Framework abhängt, die von den Standardabfragen in CodeQL nicht erkannt wird, können Sie die CodeQL-Abdeckung in Ihrem Massekonfigurationsskript erweitern, indem Sie veröffentlichte CodeQL-Modellpakete angeben. Weitere Informationen findest du unter Anpassen des erweiterten Setups für Codeüberprüfung.

Wenn Sie über viele Repositorys in Ihrer Organisation keine präzise Kontrolle über die code scanning-Konfiguration benötigen, können Sie Modellpakete mit code scanning mit dem Standardsetup im großen Stil schnell und einfach konfigurieren. Weitere Informationen findest du unter Bearbeiten der Konfiguration des Standardsetups.