Skip to main content

Informationen zur Toolstatusseite

Das 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 Seite mit dem Toolstatus?

Die Seite mit dem Toolstatus zeigt Informationen über alle Ihre code scanning-Tools an und ist ein guter Ausgangspunkt für die Fehlerbehebung, wenn code scanning nicht wie erwartet funktioniert.

Hinweis

Das Seite mit dem Toolstatus zeigt den Status des Tools nur auf Repositoryebene für den Standardbranch an, nicht auf Organisationsebene.

Toolstatusindikatoren

Die Seite mit dem Toolstatus Anzeige 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 Werkzeuge wie CodeQL

Zusätzlich zu den oben aufgeführten Informationen bietet 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

Wie CodeQL gescannte Dateien definiert

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

Interpretierte Sprachen

  • Standardkonfiguration: Die gescannten Dateien umfassen alle Quellcodedateien für alle 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 Codeüberprüfung mit CodeQL.

Kompilierte Sprachen

Die Seite mit dem Toolstatus meldet Dateien, die vor dem Ausführen von Autobuild- oder manuellen Build-Schritten 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:

Hinweis

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

Problembehandlungsfunktionen

Das Seite mit dem Toolstatus hilft Ihnen bei der Fehlerbehebung folgendermaßen:

  • 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