Hinweis
GitHub Code Quality befindet sich derzeit in öffentliche Vorschau und kann geändert werden. Während der öffentlichen Vorschauphase werden Code Quality nicht abgerechnet, obwohl Scans von Code Quality GitHub Actions Minuten verbrauchen.
Grundlegendes dazu, warum Ihre Pullanforderung blockiert ist
Repositoryadministratoren können Qualitätsrichtlinien für die Wartbarkeit und Zuverlässigkeit mithilfe von GitHub Code Quality festlegen. Wenn Sie eine Pullanforderung öffnen, wird automatisch eine Überprüfung ausgeführt, um Ihre Änderungen anhand dieser Standards zu überprüfen.
Wenn Ihr Pull-Request Code einführt, der unter den erforderlichen Schwellenwert für die Qualität fällt, wird am unteren Rand des Pull-Requests im Abschnitt "Prüfungen" ein Merge-Block-Banner angezeigt: "Das Zusammenführen ist blockiert, weil Codequalitätsprobleme festgestellt wurden."
Diese Prüfungen tragen dazu bei, eine gesunde, wartungsfähige Codebasis aufrechtzuerhalten und zu verhindern, dass technische Schulden akkumuliert werden.
Anzeigen von Scanergebnissen und deren Schweregrad
Die Ergebnisse des Scans werden als Kommentare zu deinem Pull-Request gemeldet, die du mit dem github-code-quality[bot] hinterlässt. Jeder Kommentar entspricht einem bestimmten Codequalitätsproblem, das in Ihren Änderungen erkannt wurde.
Kommentare werden nach Schweregrad bezeichnet (Fehler, Warnung, Hinweis). Weitere Informationen dazu, was die Schweregrade bedeuten, finden Sie unter Schweregraden.
Ermitteln, welche Ergebnisse Ihre Pull-Anforderung blockieren
Das von Repositoryadministratoren festgelegte Qualitätsgate definiert den minimalen Schweregrad, der die Zusammenführung blockieren wird.
Das Zusammenführungsblock-Banner kann das Mindestschweregradniveau angeben. Alle Ergebnisse ab diesem Schweregrad oder höher müssen behoben werden, bevor Sie Ihren Pull Request mischen können.
Hinweis
Wenn im Banner für den Zusammenführungsblock keine Schweregradstufe angegeben ist, bedeutet dies, dass Ihr Repository die strengsten Schwellenwerte für die Codequalität verwendet, bei denen alle gefundenen Probleme vor dem Zusammenführen behoben werden müssen.
Beheben oder Schließen jeder Feststellung
Um die Blockierung Ihrer Pullanforderung aufzuheben, müssen Sie jede erforderliche Feststellung beheben, indem Sie entscheiden, ob Sie das Problem in Ihrem Code beheben oder den Kommentar verwerfen möchten.
Nutzung von Copilot Autofix und Copilot Cloudagent zur Behebung von Erkenntnissen
Copilot Autofix
Kommentare zu der Pullanforderung enthalten ein vorgeschlagenes Autofix , das Sie direkt auf Ihre Pullanforderung übernehmen können. Überprüfen Sie sorgfältig die vorgeschlagene Autokorrektur auf Logik, Sicherheit und Stil, und klicken Sie dann auf Vorschlag übernehmen.
Sie benötigen keine Copilot Lizenz, um diese Vorschläge anzuwenden.
Copilot Cloudagent
Alternativ, wenn Sie über eine Copilot Lizenz verfügen, können Sie die Remediierungsarbeit auch Copilot Cloudagent delegieren. Kommentieren Sie die Pullanforderung und erwähnen Sie @Copilot und bitten Sie Copilot, die erkannten Probleme zu beheben.
Copilot antwortet mit einem Augen-Emoji (👀) auf Ihren Kommentar, startet eine neue Agent-Sitzung und öffnet eine Pull-Anforderung mit den erforderlichen Fixes.
Sie können die Arbeit von Copilot Cloudagent nachverfolgen.
- In der Pullanforderung wird die Zusammenfassung aktualisiert, während die Arbeit fortschreitet.
- Informationen zur Verwendung der Seite „Agents” oder „Sitzungsprotokolle” finden Sie unter Nachverfolgung der GitHub-Copilot-Sitzungen.
Zum Aufrufen von Copilot benötigen Sie eine Copilot Cloudagent-Lizenz.
Registrieren für Copilot
Verwerfen des Ergebnisses
Sie können ein Ergebnis verwerfen, wenn es im Kontext Ihrer Codebasis nicht relevant oder umsetzbar ist. Häufige Gründe zum Zurückweisen einer Feststellung sind:
- Das Ergebnis befindet sich im Legacy-Code, der nicht mehr gepflegt wird.
- Es ist eine bekannte Ausnahme für die Codierungsstandards Ihres Teams.
- Es ist ein falsch positives Ergebnis, das kein echtes Qualitätsrisiko darstellt.
Durch das Ausblenden irrelevanter Warnungen werden Ihre Qualitätsüberprüfungen auf aussagekräftige Probleme konzentriert.
Überprüfen, ob Sie die Anforderungen erfüllt haben
Um festzustellen, ob Sie die Codequalitätsanforderungen erfüllt haben, sehen Sie sich den Abschnitt "Prüfungen" unten in Ihrer Pullanforderung an. Das Zusammenführungsblock-Banner sollte nicht mehr vorhanden sein, und Sie sollten Ihre Änderungen wie gewohnt zusammenführen können.
Nächste Schritte
Verringern Sie die technischen Schulden, indem Sie Die Ergebnisse in kürzlich geänderten Dateien beheben. Weitere Informationen findest du unter Verbesserung der Qualität von kürzlich zusammengeführten Codes durch KI.