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, wird anhand von Abdeckungsmetriken angezeigt, ob eine Änderung die Abdeckung aufrecht erhält oder verringert. 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 der Standardverzweigung identifizieren regelbasierte Scans vorhandene Qualitätsschulden in Ihrer Codebasis mit Autofixen, die Sie direkt anwenden oder zuweisen können, um Copilot-Cloud-Agent sie in Ihrem Auftrag aufzulösen. Ki-basierte Analyse wird auch für kürzlich geänderte Dateien ausgeführt, wobei Probleme gekennzeichnet werden, die außerhalb vorhandener Regelsätze liegen, einschließlich sprachen, die noch nicht von Abfragen abgedeckt wurden CodeQL .
Hinweis
Bei Pullanforderungen Code Quality werden nur regelbasierte CodeQL Ergebnisse bereitgestellt. Wenn Sie auch KI-basierte Rezensionen Ihrer Pull-Anforderungen benötigen, können Sie separat aktivieren GitHub Copilot Codeüberprüfung . 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 der Abdeckungsmetriken und kann auf einen Blick erkennen, ob die Pullanforderung die Abdeckung im Vergleich zur Standardverzweigung verbessert oder reduziert.
- 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 erfasst Probleme in kürzlich geänderten Dateien, für die regelbasierte Abfragen nicht geschrieben wurden, während CodeQL Regeln gut 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 stellt Berichte in der Sicherheitsübersicht neben Sicherheitstools bereit, sodass Benutzer die Qualitätslage in der gesamten Organisation auf einen Blick erkennen, ermitteln können, welche Repositorys Aufmerksamkeit benötigen, und Verbesserungsmetriken mithilfe standardmäßiger GitHub Audit-Kontrollen und -Richtlinien nachverfolgen können.
Verfügbarkeit und Abrechnung
Die Nutzungskosten werden durch Folgendes bestimmt:
- Eine Lizenzgebühr pro Benutzer basierend auf der Anzahl aktiver Committer.
- Copilot-unterstützte Autofixe für Ergebnisse in Pullanforderungen und in der Standardverzweigung, zusammen mit KI-gestützten Erkennungen für kürzlich zusammengeführten Code, die verbrauchen GitHub AI Credits (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 KI-basierte Analysen im kürzlich geänderten Code Ihres Repositorys durch, einschließlich Sprachen, die von regelbasierten Abfragen unterstützt werden.
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.