Skip to main content

Verwenden der Toolstatusseite zum Scannen von Code

Sehen Sie den Tool-Status in Echtzeit ein, identifizieren Sie Konfigurationsprobleme und laden Sie Berichte herunter, um Ihre code scanning-Analyse reibungslos am Laufen zu halten.

Wer kann dieses Feature verwenden?

Benutzer*innen mit Schreibzugriff

Code scanning ist für die folgenden Repositorytypen verfügbar:

  • Öffentliche Repositorys auf GitHub.com
  • Organisationseigene Repositorys für GitHub Team, GitHub Enterprise Cloud oder GitHub Enterprise Server, wobei GitHub Code Security aktiviert sind.

Die Seite mit dem Toolstatus zeigt Informationen zu allen Code-Scan-Tools an und ist ein guter Ausgangspunkt für die Fehlerbehebung von Problemen. Weitere Informationen dazu, was das Tool ist und welche Informationen es bereitstellt, finden Sie unter Informationen zur Toolstatusseite.

Anzeigen der Seite mit dem Toolstatus für ein Repository

Die Seite für code scanning-Warnungen für jedes Repository enthält ein Toolbanner mit einer Zusammenfassung der Integrität deiner Codeüberprüfungsanalyse und der Möglichkeit, auf die Seite mit dem Toolstatus zuzugreifen, um dein Setup zu untersuchen.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Security. Wenn die Registerkarte „Security“ nicht angezeigt wird, klicke im Dropdownmenü auf Security.

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

  3. Klicke in der linken Randleiste auf Code scanning.

  4. Klicke auf dem Toolbanner auf Toolstatus.

           ![Screenshot: Zugreifen auf die Toolstatusseite in einem Repository. Die Schaltfläche „Toolstatus“ ist dunkelorange umrandet.](/assets/images/help/repository/code-scanning-tool-status-page-access.png)
    

Verwenden der Seite mit dem Toolstatus

Auf der Seite mit dem Toolstatus wird eine Zusammenfassung für ein einzelnes Tool angezeigt. Dieses ist auf der Seitenleiste hervorgehoben. Über die Randleiste kannst du Zusammenfassungen für verschiedene Tools anzeigen.

Screenshot der Tool-Statusseite, auf der das Tool CodeQL ausgewählt ist.

Für integrierte Tools wie CodeQL wird ein Prozentsatz aller zuletzt überprüften Dateien in deinem Repository angezeigt, sortiert nach Programmiersprache. Du kannst auch detaillierte Sprachberichte im CSV-Format herunterladen. Details zu den analysierten Dateien finden Sie unter "Herunterladen".

Zugreifen auf detaillierte Informationen zu Tools

Wenn Sie sich ausführlichere Informationen für das derzeit angezeigte Tool ansehen möchten, können Sie unter „Setup-Typen“ ein bestimmtes Setup auswählen.

Unter „Konfigurationen“ auf der linken Seite des Bildschirms werden Informationen zu den einzelnen Analysen, die mit diesem Setup-Typ durchgeführt wurden, sowie alle relevanten Fehlermeldungen angezeigt. Wenn du ausführliche Informationen zur zuletzt durchgeführten Analyse anzeigen möchtest, wähle auf der Seitenleiste eine Konfiguration aus. Du kannst Details dazu herunterladen, welche Regeln bei dieser Überprüfung des Codes angewendet und wie viele Warnungen von den einzelnen Regeln gefunden wurden. Weitere Informationen finden Sie unter Herunterladen von Listen mit den verwendeten Regeln.

Screenshot mit detaillierten Informationen zu CodeQL auf der Tool-Statusseite.

In dieser Ansicht werden auch Fehlermeldungen angezeigt. Weitere Informationen finden Sie unter Debuggen mit der Toolstatusseite.

Herunterladen von Details der analysierten Dateien

Für integrierte Tools wie CodeQL können über die Seite mit dem Toolstatus detaillierte Berichte im CSV-Format heruntergeladen werden. Darin ist Folgendes enthalten:

  • Welche Konfiguration zum Scannen der einzelnen Dateien verwendet wurde
  • Der Dateipfad
  • Die Programmiersprache der Datei
  • Gibt an, ob die Datei erfolgreich extrahiert wurde.

Wähle zum Herunterladen eines Berichts das Tool aus, für das du dich interessierst. Klicke dann rechts oben auf der Seite auf die Schaltfläche .

Herunterladen von Listen mit den verwendeten Regeln

Du kannst die Liste mit den Regeln, die von der code scanning verwendet werden, im CSV-Format herunterladen. Darin ist Folgendes enthalten:

  • Die verwendete Konfiguration
  • Die Regelquelle
  • Der SARIF-Bezeichner
  • Wie viele Warnungen gefunden wurden

Wähle zum Herunterladen eines Berichts die Konfiguration aus, für die du dich interessierst. Klicke dann rechts oben auf der Seite auf , und wähle Download list of rules used aus.

Entfernen von Konfigurationen

Sie können veraltete, doppelte oder unerwünschte Konfigurationen für den Standard-Branch deines Repositorys entfernen.

Um eine Konfiguration zu entfernen, wähle die Konfiguration aus, die du löschen möchtest. Klicke dann rechts oben auf der Seite auf , und wähle Delete configuration aus. Nachdem du die Warnung zu Warnungen gelesen hast, klicke auf die Schaltfläche Löschen, um den Löschvorgang zu bestätigen.

Hinweis

Sie können nur die Seite mit dem Toolstatus verwenden, um Konfigurationen für den Standard-Branch eines Repositorys zu entfernen. Informationen zum Entfernen von Konfigurationen aus nicht standardmäßigen Branches finden Sie unter Problemlösung für Warnungen der Codeüberprüfung.

Debuggen mithilfe der Toolstatusseite

Wenn du auf der Warnungsseite der code scanning ein Problem mit deiner Analyse feststellst, kannst du das Problem mithilfe der Seite mit dem Toolstatus identifizieren. Für integrierte Tools werden im Abschnitt mit den ausführlichen Informationen spezifische Fehlermeldungen angezeigt, die sich auf bestimmte Tools für die code scanning beziehen. Diese Fehlermeldungen enthalten Informationen dazu, warum das Tool möglicherweise nicht wie erwartet funktioniert, sowie mögliche Maßnahmen. Weitere Informationen zum Zugriff auf diesen Abschnitt der Seite mit dem Toolstatus finden Sie unter Zugreifen auf detaillierte Informationen zu Tools.

Für integrierte Tools wie CodeQL kannst du auch Dateiabdeckungsinformationen verwenden, um deine Analyse zu verbessern. Weitere Informationen zum Interpretieren von Dateiabdeckungsprozentsätzen finden Sie unter Informationen zur Toolstatusseite.

Weitere Informationen findest du unter Behebung von Fehlern bei der Code-Scan-Analyse und Problembehandlung bei SARIF-Uploads.