Konfigurieren des Standardsetups für das Codescanning

In diesem Artikel

Du kannst Code in deinem Repository schnell mit dem Standardsetup für das code scanning sichern.

Wer kann dieses Feature verwenden?

People with admin permissions to a repository, or the security manager role for the repository, can configure code scanning for that repository.

Code scanning ist für alle öffentlichen Repositorys auf GitHub.com verfügbar. Code scanning ist auch für private organisationseigene Repositorys verfügbar, die GitHub Enterprise Cloud nutzen und im Besitz einer Lizenz für GitHub Advanced Security sind. Weitere Informationen findest du unter Informationen zu GitHub Advanced Security.

Informationen zum Standardsetup

Das Standardsetup für das code scanning ist die schnellste und einfachste Möglichkeit mit dem geringsten Wartungsaufwand, um das code scanning für dein Repository zu aktivieren. Das Standardsetup erstellt auf Basis des Codes in deinem Repository automatisch eine benutzerdefinierte code scanning-Konfiguration. Nach dem Aktivieren des Standardsetups wird der Code in Ihrem Repository gescannt:

  • nach jedem Pushen in den Standard-Branch des Repositorys oder einen geschützten Branch. Weitere Informationen zu geschützten Branches findest du unter Informationen zu geschützten Branches.
  • beim Erstellen oder Committen eines Pull Requests basierend auf dem Standard-Branch des Repositorys oder einem geschützten Branch.
  • bei einem wöchentlichen Plan.

Hinweis: Wenn in einem Repository seit 6 Monaten keine Push- und Pull-Requests mit aktivierter Standardeinstellung ausgeführt wurden, wird der wöchentliche Zeitplan deaktiviert, um die GitHub Actions-Minuten zu sparen.

Du kannst die automatisch ausgewählte Konfiguration des Standardsetups aktivieren, um mit der Überprüfung deines Codes so bald wie möglich zu beginnen, oder du kannst weitere Aspekte der Konfiguration anpassen, damit sie deinen Anforderungen an das code scanning besser gerecht wird. Wenn du die Konfiguration selber anpassen möchtest, kannst du Folgendes auswählen:

  • die Sprachen, die vom Standardsetup analysiert werden
  • die Abfragesammlung, die vom Standardsetup ausgeführt wird Weitere Informationen findest du unter Integrierte CodeQL-Abfragesammlungen.

Du kannst das Standardsetup auch für mehrere oder alle Repositorys in eine Organisation gleichzeitig aktivieren. Informationen zur Massenaktivierung findest du unter Konfigurieren des Standardsetups für das Codescanning im großen Stil.

Mit dem erweiterten Setup für das code scanning erhältst du präzisere Kontrolle über deine code scanning-Konfiguration. Weitere Informationen findest du unter Konfigurieren des erweiterten Setups für das Codescanning.

Anforderungen für die Verwendung des Standardsetups

Dein Repository ist für das Standardsetup des code scanning geeignet, wenn

  • es mindestens eine von CodeQL unterstützte Sprache.
  • GitHub Actions aktiviert ist.
  • das Repository öffentlich sichtbar ist.

Du kannst das Standardsetup verwenden, wenn dein Repository Sprachen enthält, die von CodeQL nicht unterstützt werden, z. B. die Sprache R. Weitere Informationen zu den von CodeQL unterstützten Sprachen findest du unter Informationen zu Codescans mit CodeQL.

Konfigurieren des Standardsetups für ein Repository

Wenn Sie das Standardsetup für code scanning für ein Repository erstmals konfigurieren, werden alle von CodeQL unterstützten Sprachen im Repository automatisch analysiert. Die erfolgreich analysierten Sprachen werden in der neuen Standardsetup-Konfiguration beibehalten. Die nicht erfolgreich analysierten Sprachen werden in der Standardsetup-Konfiguration automatisch abgewählt.

Hinweis: Mindestens eine von CodeQL unterstützte Sprache in einem Repository muss erfolgreich analysiert werden. Andernfalls wird das Standardsetup in diesem Repository nicht erfolgreich aktiviert.

  1. Navigiere auf GitHub.com zur Hauptseite des Repositorys.

    Hinweis: Wenn Sie die Standardeinrichtung für eine Verzweigung konfigurieren, müssen Sie zuerst GitHub Actions aktivieren. Um GitHub Actions zu aktivieren, klicken Sie unter Ihrem Repositorynamen auf Actions (Aktionen), und klicken Sie dann auf I understand my workflows, go ahead and enable them (Ich verstehe meine Workflows, und sie sollen aktiviert werden). Beachten Sie, dass dadurch alle vorhandenen Workflows in Ihrer Verzweigung aktiviert werden.

  2. Wähle unter dem Namen deines Repositorys die Option Einstellungen aus. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke in der Seitenleiste im Abschnitt „Sicherheit“ auf Codesicherheit und -analyse.

  4. Wählen Sie im Abschnitt „Code scanning“ die Option Setup aus, und klicken Sie dann auf Standard.

    Screenshot: Abschnitt „Code scanning“ der Einstellungen für Codesicherheit und -analyse. Die Schaltfläche „Standardeinrichtung“ ist mit einem orangefarbenen Umriss hervorgehoben.

    Daraufhin wird das Dialogfeld „CodeQL-Standardkonfiguration“ angezeigt, in dem die code scanning-Konfiguration zusammengefasst wird, die automatisch vom Standardsetup erstellt wurde.

    1. Wähle optional im Abschnitt „Abfragesammlungen“ des modalen Dialogfelds „CodeQL-Standardkonfiguration“ das Dropdownmenü Standard aus, und klicke dann auf die CodeQL-Abfragesammlung, die du verwenden möchtest.

    Screenshot des Modals für das Standardsetup. Eine Schaltfläche namens „Standard“ mit einem Pfeil, der auf ein Dropdownmenü hinweist, ist dunkelorange umrandet.

    Wenn du dich für die Abfragesammlung Erweitert entscheidest, führt deine Konfiguration der code scanning zusätzlich zu den Abfragen der Abfragesammlung Standard Abfragen mit niedrigerem Schweregrad und geringerer Genauigkeit aus. Weitere Informationen zu den verfügbaren Abfragesammlungen findest du unter Integrierte CodeQL-Abfragesammlungen.

    Hinweis: Wenn du die code scanning für die Verwendung der Abfragesammlung Erweitert konfigurierst, tritt möglicherweise eine höhere Rate falsch positiver Warnungen auf.

  5. Überprüfe die Einstellungen für das Standardsetup in deinem Repository, und klicke dann auf CodeQL aktivieren. Dadurch wird ein Workflow ausgelöst, der die neue, automatisch generierte Konfiguration testet.

    Hinweis: Wenn du vom erweiterten zum Standardsetup wechselst, wird dir eine Warnung angezeigt, die dich darüber informiert, dass das Standardsetup deine vorhandenen code scanning-Konfigurationen überschreibt. Diese Warnung bedeutet, dass das Standardsetup die vorhandene Workflowdatei deaktiviert und jegliche Uploads der CodeQL-Analyse-API blockiert.

  6. Um nach der Neuaktivierung deine Standardsetupkonfiguration einzusehen, wähle optional aus, und klicke dann auf CodeQL-Konfiguration anzeigen.

Nächste Schritte

Nachdem du das Standardsetup für das code scanning konfiguriert hast und deine Konfiguration mindestens einmal erfolgreich ausgeführt wurde, kannst du code scanning-Warnungen untersuchen und beheben. Weitere Informationen zu code scanning-Warnungen findest du unter Informationen zu Codeüberprüfungswarnungen und Verwalten von Codescanwarnungen für dein Repository.

Ausführliche Informationen zu deiner code scanning-Konfiguration, einschließlich Zeitstempeln für jede Überprüfung und dem Prozentsatz der überprüften Dateien, findest du auf der Seite „Toolstatus“. Weitere Informationen findest du unter Informationen zur Toolstatusseite für die Codeüberprüfung.

Beim Konfigurieren des Standardsetups tritt möglicherweise ein Fehler auf. Weitere Informationen zum Behandeln bestimmter Fehlern findest du unter Problembehandlung bei der Codeüberprüfung.