GitHub Code Quality analysiert Ihren Code auf Qualitäts- und Abdeckungsprobleme und liefert Copilot-unterstützte Korrekturen, die Sie mit nur einem Klick anwenden können. Es läuft an zwei Stellen:
- Bei Pullanforderungen werden deterministische Code Quality Regeln verwendet, CodeQL um bekannte Antimuster zu erkennen und Ergebnisse als Inlinekommentare zu posten, bevor Code zusammengeführt wird. Wenn Sie einen Cobertura XML-Abdeckungsbericht hochladen, zeigen die Zeilenabdeckungsmetriken an, ob eine Änderung die Abdeckung aufrecht erhält oder reduziert. Sie können Qualitäts- und Abdeckungsschwellenwerte mit Regelsätzen erzwingen, um Pullanforderungen zu blockieren, die Ihre Kriterien nicht erfüllen, sodass neue Qualitätsschulden nicht akkumuliert werden.
- Auf dem Standard-Branch identifizieren regelbasierte Scans bestehende Qualitätsschulden in Ihrer Codebasis; verfügbare Autofixes können Sie direkt anwenden oder Copilot cloud agent zuweisen, damit diese sie in Ihrem Auftrag beheben. KI-basierte Analyse läuft auch auf kürzlich geänderten Dateien und kennzeichnet Probleme, die nicht durch vorhandene Regelsätze abgedeckt sind, einschließlich Sprachen, die noch nicht von CodeQL Abfragen abgedeckt werden.
Hinweis
Bei Pull Requests meldet Code Quality nur regelbasierte CodeQL Ergebnisse. Wenn Sie auch KI-gestützte Überprüfungen Ihrer Pull Requests möchten, können Sie GitHub Copilot code review separat aktivieren. Siehe Informationen zur GitHub Copilot Code-Review.
Anwendungsfälle
GitHub Code Quality So sieht es in der Praxis aus.
Für Entwickler und Teams:
- Ein Entwickler öffnet eine Pull-Anforderung , die ein Zuverlässigkeits- oder Wartungsproblem darstellt. Code Quality veröffentlicht einen Kommentar zur Erläuterung des Problems und bietet eine Einklickkorrektur, bevor der Code zusammengeführt wird. Der Entwickler sieht auch einen Bericht mit Metriken zur Zeilenabdeckung und kann auf einen Blick erkennen, ob der Pull Request die Abdeckung im Vergleich zum Standard-Branch verbessert oder verringert.
- Ein Team erbt eine große Codebasis mit Jahren akkumulierter Qualitätsschulden. Code Quality überprüft den Standardbranch, zeigt Befunde mit automatischen Korrekturen in einem Dashboard an, und das Team weist Copilot cloud agent die Arbeiten im Zusammenhang mit der Behebung zu, damit automatisch Pull Requests mit Korrekturen erstellt werden.
- Ein Team setzt KI-Codierungsassistenten ein und braucht die Gewissheit, dass generierter Code denselben Standard erfüllt wie manuell geschriebener Code. KI-basierte Analyse erkennt Probleme in kürzlich geänderten Dateien, für die keine regelbasierten Abfragen geschrieben wurden, während CodeQLRegeln klar definierte Antimuster abdecken.
Für Administratoren und Leads:
- Ein Engineering Lead legt Abdeckungs- und Qualitätsschwellenwerte mithilfe von Regelsätzen fest. Pull Requests, die die Kriterien nicht erfüllen, werden am Zusammenführen gehindert, sodass keine neuen Qualitäts- oder Abdeckungslücken angesammelt werden.
- Ein Administrator benötigt Einblick in Repositories übergreifend, um Audits oder Compliance-Berichte zu unterstützen. Code Quality Berichte in der Sicherheitsübersicht neben den Sicherheitstools, damit Benutzer den aktuellen Qualitätsstatus in der gesamten Organisation einsehen, überprüfen können, wie sich offene Befunde im Laufe der Zeit verändert haben, und erkennen, welche Repositorys Aufmerksamkeit benötigen. Siehe Untersuchung der GitHub-Codequalitätsergebnisse in Ihrer Organisation.
Verfügbarkeit und Abrechnung
Die Nutzungskosten werden durch Folgendes bestimmt:
- Eine Lizenzgebühr pro Benutzer basierend auf der Anzahl aktiver Committer.
- Copilot-gestützte Autofixes für Befunde in Pull Requests und im Standard-Branch sowie KI-gestützte Erkennungen in kürzlich zusammengeführtem Code, die GitHub AI Credits verbrauchen (keine Copilot-Lizenz erforderlich).
- GitHub Actions Minuten für deterministische CodeQL Scans, wenn Sie keine selbst gehosteten Runner verwenden.
Optionale Funktionen, z. B. die Delegation der Behebung von Codequalitätsproblemen an Copilot, erfordern eine Copilot-Lizenz.
Weitere Informationen findest du unter GitHub Code Quality Abrechnung.
Unterstützte Sprachen
Code Qualityführt eine regelbasierte Analyse der folgenden Sprachen durch:CodeQL
- C#
- Go
- Java
- JavaScript
- Python
- Rubin
- TypeScript
Code Quality führt außerdem eine KI-gestützte Analyse des kürzlich geänderten Codes in Ihrem Repository durch, einschließlich von Sprachen, die über die von regelbasierten Abfragen unterstützten hinausgehen.
Nächste Schritte
- Erfahren Sie, wie Sie Codequalitätsergebnisse für Ihre Pull-Anforderung beheben. Siehe Verhindern, dass Probleme mit der Codequalität Ihren Standard-Branch erreichen.