Skip to main content

Überprüfen von Abhängigkeitsänderungen in einem Pull Request

Überprüfen Sie Abhängigkeitsänderungen in Pullanforderungen, um hinzugefügte, aktualisierte oder entfernte Abhängigkeiten zu identifizieren und Sicherheitsrisiken zu erkennen, bevor sie die Produktion erreichen.

Wer kann dieses Feature verwenden?

Die Abhängigkeitsüberprüfung ist für die folgenden Repositorytypen verfügbar:

  • Öffentliche Repositorys auf GitHub.com
  • Repositorys im Besitz von Organisationen auf GitHub Team, die GitHub Code Security aktiviert haben

Informationen zur Abhängigkeitsüberprüfung

Die Abhängigkeitsüberprüfung hilft Dir, Abhängigkeitsänderungen und die Sicherheitswirkung dieser Änderungen bei jedem Pull Request zu verstehen. Sie bietet eine leicht verständliche Visualisierung von Abhängigkeitsänderungen mit Rich-Diff auf der Registerkarte „Geänderte Dateien“ eines Pull Requests. Die Abhängigkeitsüberprüfung informiert Dich über:

  • Welche Abhängigkeiten hinzugefügt, entfernt oder aktualisiert wurden, sowie die Releasedaten
  • Wie viele Projekte diese Komponenten verwenden
  • Sicherheitsrisikodaten für diese Abhängigkeiten

Die Abhängigkeitsüberprüfung hilft Ihnen, anfällige Abhängigkeiten zu finden, bevor sie die Produktion erreichen. Siehe Abhängigkeitsüberprüfung.

Sie können Abhängigkeitsüberprüfungsaktion dazu verwenden, Abhängigkeitsüberprüfungen für Pull Requests in Ihrem Repository durchzusetzen. Die Abhängigkeitsüberprüfungsaktion prüft deine Pull Requests auf Änderungen bei Abhängigkeiten und gibt einen Fehler aus, wenn neue Abhängigkeiten bekannte Sicherheitsrisiken aufweisen. Die Aktion wird von einem API-Endpunkt unterstützt, der die Abhängigkeiten zwischen zwei Revisionen vergleicht und etwaige Unterschiede meldet.

Weitere Informationen zur Aktion und zum API-Endpunkt findest du in der Dokumentation dependency-review-action und unter REST-API-Endpunkte für die Abhängigkeitsüberprüfung.

Sie können die Abhängigkeitsüberprüfungsaktion Anforderungen besser anpassen, indem Sie den Typ der Abhängigkeitslücke angeben, die Sie erfassen möchten. Siehe Konfigurieren der Aktion zur Überprüfung von Abhängigkeiten.

Überprüfen von Abhängigkeiten in einem Pull Request

  1. Klicke unter dem Namen deines Repositorys auf Pull requests.

    Screenshot der Hauptseite eines Repositorys. In der horizontalen Navigationsleiste ist eine Registerkarte mit der Bezeichnung „Pull Requests“ dunkelorange umrandet.

  2. Klicke in der Liste der Pull Requests auf den Pull Request, den Du überprüfen möchtest.

  3. Klicke im Pull Request auf Files changed.

    Screenshot der Registerkarten für einen Pull Request. Die Registerkarte „Dateien geändert“ ist dunkelorange umrandet.

  4. Wenn der Pull Request viele Dateien enthält, verwende das Dropdownmenü Dateifilter, um alle Dateien auszublenden, die keine Abhängigkeiten aufzeichnen. Dadurch wird es einfacher, sich auf die Abhängigkeitsänderungen zu konzentrieren.

Screenshot: Registerkarte „Geänderte Dateien“. Eine Dropdownliste mit der Bezeichnung „Dateifilter“ wird erweitert und zeigt eine Liste von Dateitypen mit Kontrollkästchen an. Die Abhängigkeitsüberprüfung bietet eine klarere Ansicht der Änderungen in großen Sperrdateien, bei denen der Quell-Diff nicht standardmäßig angezeigt wird.

Hinweis

Umfangreiche Diffs für die Abhängigkeitsüberprüfung sind für festgeschriebene statische JavaScript-Dateien wie jquery.js nicht verfügbar.

  1. Um die Abhängigkeitsüberprüfung anzuzeigen, klicken Sie bei einer Manifest- oder Sperrdatei rechts in der Kopfzeile auf .

    Screenshot: Registerkarte „Geänderte Dateien“ eines Pull Requests. Die Schaltfläche zum Anzeigen des Rich Diff (gekennzeichnet durch ein Dateisymbol) ist mit einer dunkelorangen Linie umrandet.

  2. Überprüfe die in der Abhängigkeitsüberprüfung aufgeführten Abhängigkeiten.

    Screenshot: Warnungen zu Sicherheitsrisiken in einer Abhängigkeitsüberprüfung für einen Pull Request.

    Alle hinzugefügten oder geänderten Abhängigkeiten, die Sicherheitsrisiken aufweisen, werden zuerst aufgelistet, sortiert nach Schweregrad und dann nach Abhängigkeitsnamen. Dies bedeutet, dass die Abhängigkeiten mit dem höchsten Schweregrad in einer Abhängigkeitsüberprüfung immer oben liegen. Andere Abhängigkeiten werden alphabetisch nach Abhängigkeitsnamen aufgeführt.

    Das Symbol neben jeder Abhängigkeit gibt an, ob die Abhängigkeit in dieser Pullanforderung hinzugefügt (), aktualisiert () oder entfernt () wurde.

    Diese Informationen umfassen Folgendes:

    • Die Version, oder der Versionsbereich der neuen, aktualisierten oder gelöschten Abhängigkeit.
    • Für eine bestimmte Version einer Abhängigkeit:
      • Das Alter dieser Veröffentlichung der Abhängigkeit.
      • Die Anzahl der Projekte, die von dieser Software abhängen. Diese Informationen werden aus dem Abhängigkeitsdiagramm abgeleitet. Wenn du die Anzahl der Abhängigen überprüfst, kannst du vermeiden, versehentlich die falsche Abhängigkeit hinzuzufügen.
      • Die von dieser Abhängigkeit verwendete Lizenz, sofern diese Informationen verfügbar sind. Dies ist hilfreich, wenn Sie code mit bestimmten Lizenzen in Ihrem Projekt vermeiden möchten.

    Wenn eine Abhängigkeit ein bekanntes Sicherheitsrisiko aufweist, enthält die Warnmeldung Folgendes:

    • Eine kurze Beschreibung des Sicherheitsrisikos.
    • Eine allgemeine Identifikationsnummer für Sicherheitsrisiken und Gefährdungen (CVE) oder GitHub Security Advisories (GHSA). Du kannst auf diese ID klicken, um mehr über das Sicherheitsrisiko zu erfahren.
    • Der Schweregrad des Sicherheitsrisikos.
    • Die Version der Abhängigkeit, in der das Sicherheitsrisiko behoben wurde. Wenn du einen Pull Request für jemanden überprüfst, bitte den Mitwirkenden, die Abhängigkeit auf die gepatchte Version oder eine spätere Version zu aktualisieren.
  3. Du solltest auch das Quell-Diff überprüfen, da es möglicherweise Änderungen an der Manifest- oder Sperrdatei gibt, die keine Abhängigkeiten ändern. Zudem besteht die Möglichkeit, dass Abhängigkeiten verfügbar sind, die GitHub nicht analysieren kann und die daher nicht in der Abhängigkeitsüberprüfung angezeigt werden.

    Klicke auf die Schaltfläche , um zur Ansicht für das Quelldiff zurückzukehren.

    Screenshot der Registerkarte „Geänderte Dateien“ eines Pull Requests. Die Schaltfläche zum Anzeigen des Quell-Diffs, angezeigt mit einem Codesymbol, ist orange umrandet.