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 Ergebnisse als Inlinekommentare angezeigt, 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.
- Im Standard-Branch identifizieren Scans bestehende Qualitätsschulden in Ihrer Codebasis, mit automatischen Korrekturen, die Sie direkt anwenden oder Copilot-Cloud-Agent zuweisen können, damit diese sie in Ihrem Namen beheben.
Die Erkennung kombiniert deterministische CodeQL Regeln für bekannte Antimuster mit KI-basierter Analyse für Probleme, die außerhalb vorhandener Regelsätze liegen, einschließlich sprachen, die noch nicht von Abfragen abgedeckt werden CodeQL .
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 setzt KI-Codierungsassistenten ein und braucht die Gewissheit, dass generierter Code denselben Standard erfüllt wie manuell geschriebener Code. KI-basierte Analysen erkennen Probleme, für die regelbasierte Abfragen nicht ausgelegt waren, während CodeQL Regeln klar definierte Antimuster abdecken.
- Ein Team erbt eine große Codebasis mit Jahren akkumulierter Qualitätsschulden. Code Quality scannt den Standard-Branch, zeigt Befunde mit automatischen Korrekturen in einem Dashboard an, und das Team weist Copilot-Cloud-Agent die Behebungsarbeit zu, damit automatisch Pull Requests mit Korrekturen erstellt werden.
Für Administratoren und Leads:
- Ein Engineering Lead legt Abdeckungs- und Qualitätsschwellenwerte mithilfe von Regelsätzen fest. Pull-Anforderungen, die die Kriterien nicht erfüllen, werden am Zusammenführen gehindert, sodass keine neuen Qualitäts- oder Deckungsschulden 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 Nutzer, basierend auf der Anzahl aktiver Committer.
- KI-gestützte Erkennungen und Copilot-gestützte automatische Korrekturen, die GitHub AI Credits verbrauchen (keine Copilot-Lizenz erforderlich).
- GitHub Actions Minuten für deterministische CodeQL Scans, wenn Sie keine selbst gehosteten Läufer 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
Außerdem führt sie KI-gestützte Analysen bei Pull Requests und am kürzlich geänderten Code in Ihrem Repository aus, einschließlich von Sprachen, die über die von regelbasierten Abfragen unterstützten hinausgehen.
Nächste Schritte
- Für Ihr Unternehmen: Stellen Sie sicher, dass Repositories in Ihrem Unternehmen aktiviert werden könnenCode Quality. Siehe Verwendung von GitHub Code Quality in Ihrem Unternehmen zulassen.
- Für Ihr Repository oder Ihre Organisation: Aktivieren Sie, Code Quality um mit dem Generieren von Ergebnissen zu beginnen. Siehe Aktivieren von GitHub Code Quality.
- In Ihrem Pull Request: Erfahren Sie, wie Sie Erkenntnisse zur Codequalität in Ihrem Pull Request beheben. Siehe Verhindern, dass Probleme mit der Codequalität Ihren Standard-Branch erreichen.