Lösen von Code-Scan-Warnungen

Beheben einer Warnung

Alle Benutzer mit Schreibberechtigung für ein Repository können eine Warnung beheben, indem sie eine Korrektur am Code committen. Wenn im Repository die Ausführung von code scanning für Pull Requests geplant ist, empfiehlt es sich am besten, einen Pull Request mit der Korrektur einzureichen. Dadurch wird eine code scanning-Analyse der Änderungen ausgelöst und geprüft, ob Ihre Änderung keine neuen Probleme verursacht. Weitere Informationen finden Sie unter Filtern von Codescanbenachrichtigungen in Pull-Anforderungen.

Du kannst die Freitextsuche oder die Filter nutzen, um eine Teilmenge der Warnungen anzuzeigen und dann alle übereinstimmenden Warnungen als geschlossen markieren.

Warnungen können in einem Branch behoben werden, aber nicht in einem anderen. Du kannst den Filter „Branch“ in der Zusammenfassung der Warnungen verwenden, um zu überprüfen, ob eine Warnung in einem bestimmten Branch behoben ist.

Screenshot der Benachrichtigungsansicht mit erweiterten Optionen für Branches. Der Filter „Branch“ ist dunkelorange unterstrichen.

Beachte, dass, wenn du nach Warnungen in einem Nicht-Standardbranch gefiltert hast, dieselben Warnungen aber im Standardbranch vorhanden sind, die Warnungsseite für eine bestimmte Warnung trotzdem nur den Status der Warnung im Standardbranch anzeigt, auch wenn dieser Status mit dem Status in einem Nicht-Standardbranch in Widerspruch steht. So kann eine Warnung, die in der Liste „Offen“ in der Warnungsübersicht für branch-x auftaucht, auf der Warnungsseite den Status „Behoben“ haben, wenn die Warnung im Standardbranch bereits behoben ist. Du kannst den Status der Warnung für den Branch, den du gefiltert hast, im Abschnitt Betroffene Branches auf der rechten Seite der Warnungsseite einsehen.

Hinweis

Wenn du code scanning mit mehreren Konfigurationen ausführst, wird die gleiche Warnung manchmal von mehreren Konfigurationen generiert. Wenn du nicht alle Konfigurationen regelmäßig ausführst, werden möglicherweise Warnungen angezeigt, die in einer Konfiguration behoben sind, aber nicht in einer anderen. Diese veralteten Konfigurationen und Warnungen können aus einem Branch entfernt werden. Weitere Informationen findest du unter Entfernen veralteter Konfigurationen und Warnungen aus einem Branch.

Verwerfen von Warnungen

Es gibt zwei Möglichkeiten zum Schließen einer Warnung. Du kannst das Problem im Code beheben oder die Warnung verwerfen.

Das Verwerfen einer Warnung ist eine Möglichkeit, eine Warnung zu entfernen, die deiner Meinung nach nicht behoben werden muss. Sie können Warnungen aus code scanning-Anmerkungen im Code oder in der Zusammenfassungsliste innerhalb der Registerkarte Sicherheit ignorieren.

Wenn du eine Warnung verwirfst, passiert Folgendes:

Es wird in allen Zweigen abgelehnt.
Die Warnung wird aus den aktuellen Warnungen für dein Projekt entfernt.
Die Warnung wird in der Zusammenfassung der Warnungen in die Liste „Geschlossen“ verschoben, aus der du die Warnung bei Bedarf erneut öffnen kannst.
Der Grund, warum du die Warnung geschlossen hast, wird aufgezeichnet.
Optionalerweise kannst du eine Abweisung kommentieren, um den Kontext des Abweisens einer Warnung festzuhalten.
Wenn code scanning das nächste Mal ausgeführt wird, wird durch denselben Code keine Warnung mehr generiert.

So blenden Sie Warnungen aus:

Navigieren Sie auf GitHub zur Hauptseite des Repositorys.
Klicke unter dem Repositorynamen auf Security. Wenn die Registerkarte „Security“ nicht angezeigt wird, klicke im Dropdownmenü auf Security.
Klicke in der linken Randleiste auf Code scanning.
Wenn du eine Warnung verwerfen möchtest, ist es wichtig, die Warnung zunächst zu begutachten, damit du den richtigen Grund zum Verwerfen auswählen kannst. Klicke auf die Warnung, die du begutachten möchtest.

Überprüfe die Warnung. Klicke dann auf Warnung schließen, und wähle einen Grund für das Schließen der Warnung aus, oder gib einen Grund ein.

          ![Screenshot eines Fehlers bei der Warnungsprüfung. Die Schaltfläche „Benachrichtigung verwerfen“ ist in Dunkelorange hervorgehoben, und das Dropdown-Menü „Verwerfen“ wird angezeigt. 
       ](/assets/images/help/repository/code-scanning-alert-dropdown-reason.png) Es ist wichtig, den entsprechenden Grund aus dem Dropdownmenü auszuwählen, weil sich dies darauf auswirken kann, ob eine Abfrage weiterhin in zukünftigen Analysen berücksichtigt wird. Optional können Sie die Zurückweisung kommentieren, um den Kontext der Zurückweisung einer Warnung aufzuzeichnen. Der Kommentar zur Zurückweisung wird zur Zeitleiste der Warnung hinzugefügt und kann bei Prüfungen und Berichterstellungen als Begründung verwendet werden. Du kannst einen Kommentar über die REST-API für die Codeüberprüfung abrufen oder festlegen. Der Kommentar ist in `dismissed_comment` für den Endpunkt `alerts/{alert_number}` enthalten. Weitere Informationen finden Sie unter [AUTOTITLE](/rest/code-scanning/code-scanning#update-a-code-scanning-alert).

Wenn du eine CodeQL-Warnung als False Positive-Ergebnis schließt, z. B. weil der Code eine nicht unterstützte Bereinigungsbibliothek verwendet, solltest du zum CodeQL-Repository beitragen und die Analyse verbessern. Weitere Informationen zu CodeQL findest du unter Beitragen zu CodeQL.

Gleichzeitiges Verwerfen mehrerer Warnungen

Wenn ein Projekt mehrere Benachrichtigungen aufweist, die du aus demselben Grund verwerfen möchtest, kannst du die Benachrichtigungen in der Zusammenfassung der Benachrichtigungen in einem Schritt verwerfen. Normalerweise musst du die Liste filtern und dann alle übereinstimmenden Warnungen verwerfen. Beispielsweise könnten Sie alle aktuellen Warnungen im Projekt abbrechen, die mit einer Markierung für eine bestimmte CWE-Schwachstelle (Common Weakness Enumeration) versehen wurden.

Erneutes Öffnen ignorierter Warnungen

Wenn Sie einen Alarm schließen, aber später feststellen, dass Sie den Alarm beheben müssen, können Sie ihn erneut öffnen und das Problem mit dem Code beheben. Zeige die Liste der geschlossenen Warnungen an, suche die Warnung, zeige sie an, und öffne sie erneut. Du kannst die Warnung dann auf die gleiche Weise wie jede andere Warnung beheben.

Entfernen veralteter Konfigurationen und Alarme aus einem Branch

Möglicherweise verfügst du über mehrere Codeüberprüfungskonfigurationen für ein einzelnes Repository. Bei der Ausführung können mehrere Konfigurationen dieselbe Warnung generieren. Wenn die Konfigurationen zusätzlich nach unterschiedlichen Zeitplänen ausgeführt werden, können die Warnungsstatus für unregelmäßige oder abgelaufene Konfigurationen veraltet sein. Weitere Informationen zu Warnungen aus mehreren Konfigurationen findest du unter Informationen zu Codeüberprüfungswarnungen.

Navigieren Sie auf GitHub zur Hauptseite des Repositorys.
Klicke unter dem Repositorynamen auf Security. Wenn die Registerkarte „Security“ nicht angezeigt wird, klicke im Dropdownmenü auf Security.
Klicke in der linken Randleiste auf Code scanning.
Klicke unter „Code scanning“ auf eine code scanning-Warnung.
Klicke im Abschnitt „Betroffene Branches“ in der Randleiste auf den gewünschten Branch.
Überprüfe im Dialogfeld „Konfigurationen analysieren“ die Details der Konfigurationen, die diese Warnung für den ausgewählten Branch gemeldet haben. Um eine unerwünschte Konfiguration für den gewünschten Branch zu löschen, klicke auf .

Wenn du eine Konfiguration versehentlich gelöscht hast, klicke auf Abbrechen, damit die Änderungen nicht angewendet werden.
Nachdem du unerwünschte Konfigurationen entfernt hast und bestätigt hast, dass die erwarteten Konfigurationen angezeigt werden, klicke auf Änderungen speichern.

Wenn du deine Änderungen nach dem versehentlichen Löschen einer Konfiguration speicherst, führe die Konfiguration erneut aus, um die Warnung zu aktualisieren. Weitere Informationen zum erneuten Ausführen von Konfigurationen, die GitHub Actions verwenden, findest du unter Erneutes Ausführen von Workflows und Jobs.