Skip to main content

Informationen zur Toolstatusseite

Die Seite mit dem Toolstatus bietet Einblick in den Zustand und die Leistung der code scanning-Tools in Ihrem Repository.

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.

Was ist die Seite mit dem Toolstatus?

Die Seite mit dem Toolstatus zeigt Informationen zu allen code scanning-Tools an und ist ein guter Ausgangspunkt für das Debuggen von Problemen, wenn code scanning nicht wie erwartet funktioniert.

Hinweis

Die Seite mit dem Toolstatus zeigt den Toolstatus auf der Repositoryebene nur für die Standardverzweigung an, nicht auf der Organisationsebene.

Toolstatusindikatoren

Die Seite mit dem Toolstatus zeigt einen von drei Status an:

  •         **Alle Konfigurationen funktionieren: Alle** Tools funktionieren erwartungsgemäß.
    
  •         **Einige Konfigurationen benötigen Aufmerksamkeit: Einige Tools weisen** Warnungen oder nicht kritische Probleme auf
    
  •         **Einige Konfigurationen funktionieren nicht**: Mindestens ein Tools hat kritische Fehler.
    

Welche Informationen verfügbar sind

Für alle code scanning-Tools

  • Konfigurationsstatus und Integritätszustand
  • Scan-Zeitplanung
  • Erste und aktuellste Scanzeiten
  • Regeln, die in Scans verwendet werden

Für integrierte Tools wie CodeQL

Zusätzlich zu den oben aufgeführten Informationen enthält die Seite mit dem Toolstatus für integrierte Tools die folgenden Details:

  • Prozentsatz der Dateiabdeckung nach Programmiersprache
  • Konfigurationsdetails für jeden Setuptyp
  • Spezifische Fehlermeldungen
  • Herunterladbare CSV-Berichte von analysierten Dateien
  • Herunterladbare Listen mit verwendeten Regeln und Warnungszählungen

Definition überprüfter Dateien von CodeQL

CodeQL meldet, dass eine Datei gescannt wurde, wenn einige Codezeilen in dieser Datei verarbeitet wurden.

Interpretierte Sprachen

  •         **Standardkonfiguration**: Gescannte Dateien enthalten alle Quellcodedateien für Sprachen, die CodeQL analysieren kann
    
  •         **Erweiterte Einrichtung**: Sie können verwenden `paths` und `paths-ignore` definieren, welche Dateien überprüft werden sollen. Weitere Informationen findest du unter [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql).
    

Kompilierte Sprachen

Die Seite mit dem Toolstatus meldet Dateien, die vor dem Ausführen von AutoBuild- oder manuellen Buildschritten vorhanden sind. Dateien, die während des Buildvorgangs generiert werden, werden nicht angezeigt. Weitere Informationen findest du unter CodeQL-Codeüberprüfung für kompilierte Sprachen.

Abdeckungsberechnung

Die Prozentsätze der Dateiabdeckung berücksichtigen alle Dateien, die von den Konfigurationseigenschaften paths und paths-ignore ausgeschlossen werden.

Grundlegendes zu Dateiabdeckungsprozentsätzen

Verwenden Sie Dateiabdeckungsprozentsätze, um Ihre Analyse zu debuggen und zu verbessern:

  •           **Hoher Prozentsatz**: Code scanning funktioniert wie erwartet für diese Sprache.
    
  •         **Niedriger Prozentsatz**: Untersuchen Sie die Diagnoseausgabe. Weitere Informationen findest du unter [AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected).
    
  •         **Nullprozentsatz**: Möglicherweise sind Code in Sprachen vorhanden, die derzeit nicht analysiert werden. Aktualisieren Sie Ihr Setup so, dass diese Sprachen enthalten sind. Weitere Informationen findest du unter [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#changing-the-languages-that-are-analyzed).
    

Hinweis

Wenn Sie sowohl das erweiterte Setup als auch das Standardsetup einrichten, zeigt das Seite mit dem Toolstatus nur das Standardsetup an.

Problembehandlungsfunktionen

Die Seite mit dem Toolstatus hilft Ihnen bei der Fehlerbehebung durch:

  •         **Fehlermeldungen**: Erläutert, warum Tools nicht wie erwartet mit vorgeschlagenen Aktionen ausgeführt werden
    
  •         **Dateiabdeckungsdaten**: Zeigt an, welche Dateien und Sprachen analysiert werden
    
  •         **Konfigurationsdetails**: Zeigt Informationen zu den einzelnen Analyseausführungen an.
    
  •         **Herunterladbare Berichte**: Stellt CSV-Berichte mit detaillierten Datei- und Regelinformationen bereit.
    

Weiterführende Lektüre

  •         [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/use-the-tools-status-page-for-code-scanning)