Skip to main content

Konfigurieren des Standardsetups für das Codescanning

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 organisationseigene Repositorys in GitHub Enterprise Server verfügbar. Dieses Feature erfordert eine Lizenz für GitHub Advanced Security. 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 CodeQL-unterstützten Sprachen in deinem Repository überprüft:

  • 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 Festschreiben einer Pull-Anfrage basierend auf dem Standardzweig des Repositorys oder einem beliebigen geschützten Zweig, ausgenommen Pull-Anfragen von Forks.
  • 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 GitHub Actions-Minuten zu sparen.

Du kannst das Standard-Setup auch für mehrere oder alle Repositorys in einer 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 enthält mindestens eine von CodeQL unterstützte Sprache.
  • GitHub Actions aktiviert ist.
  • GitHub Advanced Security ist aktiviert.

Wenn dein Repository mindestens eine von CodeQL unterstützte Sprache enthält, kannst du das Standardsetup auch verwenden, wenn dein Repository auch Sprachen enthält, die von CodeQL nicht unterstützt werden, wie zum Beispiel nicht von R. Nicht unterstützte Sprachen werden nicht standardmäßig durchsucht. Weitere Informationen zu den von CodeQL unterstützten Sprachen finden Sie unter Informationen zu Codescans mit CodeQL.

Sie können das Standardsetup mit selbst gehosteten Runnern für alle von CodeQL-unterstützten Sprachen verwenden. Das Standard-Setup führt die autobuild Aktion aus. Daher sollten Sie Ihre selbst gehosteten Runner konfigurieren, um sicherzustellen, dass sie alle erforderlichen Befehle für die C/C++, C#, Go, Java und Swift-Analyse ausführen können. Die Analyse von Javascript/TypeScript, Go, Ruby, Python und Kotlin erfordert derzeit keine spezielle Konfiguration.

Anpassen des Standardsetups

Es wird empfohlen, code scanning mit der Standardeinrichtung zu verwenden. Nachdem du das Standardsetup konfiguriert haben, kannst du code scanning auswerten, um zu sehen, wie es für dich funktioniert. Wenn du feststellst, dass etwas nicht wie erwartet funktioniert, kannst du das Standardsetup anpassen, um deine Codesicherheitsanforderungen besser zu erfüllen. Weitere Informationen findest du unter Auswerten des Standardsetups für die Codeüberprüfung.

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 Ihre GitHub Enterprise Server-Instance 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 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 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.

Nachdem du das Standardsetup fürcode scanning konfiguriert hast, kannst du dich darüber informieren, wie du auswerten kannst, wie gut das Ganze für dich funktioniert, sowie über die nächsten Schritte, die du ausführen kannst, um es anzupassen. Weitere Informationen findest du unter Auswerten des Standardsetups für die Codeüberprüfung.

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.