Skip to main content

Informationen zu GitHub Codequalität

Verwenden Sie GitHub Code Quality, um Codequalitätsprobleme in Pull-Anfragen und Repositoryscans zu kennzeichnen, Autofixes mittels Copilot anzuwenden und Standards mit Regelsets durchzusetzen.

Wer kann dieses Feature verwenden?

GitHub Team oder GitHub Enterprise Cloud

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.

Überblick

          GitHub Code Quality hilft Ihnen sicherzustellen, dass Ihre Codebasis zuverlässig, wartbar und effizient ist. Ganz gleich, ob Sie eine neue Funktion entwickeln, technische Schulden reduzieren oder den Status des Repositorys berichten, Code Quality bietet Ihnen umsetzbare Erkenntnisse und automatisierte Korrekturen, damit Sie die Codequalität Ihres Repositorys effizient verbessern und verwalten können.

Wichtige Features und Vorteile

Mit Code Quality haben Sie folgende Möglichkeiten:

  • Identifizieren Sie Codequalitätsrisiken und Chancen bei Pullanforderungen und durch Repositoryscans.
  • Überprüfen Sie klare Erklärungen zu den Befunden und wenden Sie mit nur einem Klick automatisch KorrekturenCopilot an.
  • Verwenden Sie Repositorydashboards , um Zuverlässigkeits- und Wartungsbewertungen nachzuverfolgen, Bereiche zu identifizieren, die Aufmerksamkeit benötigen, und priorisieren Sie die Korrektur.
  • Überwachen Sie Organisationsdashboards , um den Codestatus Ihrer Repositorys auf einen Blick zu verstehen und zu bestimmen, welche Repositorys weiter untersucht werden sollen.
  • Richten Sie Regelsätze für Pullanforderungen ein, um Codequalitätsstandards zu erzwingen und Änderungen zu blockieren, die Ihren Kriterien nicht entsprechen.
  • Mit einer Copilot Lizenz können Sie problemlos Behebungsaufgaben Copilot-Cloud-Agent zuweisen.

Verfügbarkeits- und Nutzungskosten

          GitHub Code Quality ist für Repositories, die sich im Besitz der Organisation befinden, bei GitHub Team und GitHub Enterprise Cloud Plänen verfügbar.

          GitHub Code Quality wird während der öffentlichen Vorschau nicht in Rechnung gestellt. Jedoch verbrauchen Code Quality Scans GitHub Actions Minuten. Weitere Informationen findest du unter [AUTOTITLE](/billing/concepts/product-billing/github-code-quality).

Hinweis

  • Sie benötigen weder eine Copilot noch eine Code Security Lizenz, um Code Quality zu verwenden oder Copilot-basierte Autofixes anzuwenden.

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 auch KI-basierte Analysen mit Ergebnissen aus, die separat im Repository-Dashboard "**KI-Ergebnisse**" angezeigt werden. Im Gegensatz zur regelbasierten CodeQL Analyse, die die gesamte Codebasis und Pull-Anfragen überprüft, untersucht diese KI-basierte Analyse nur Dateien, die kürzlich in den Standardzweig übertragen wurden, und kann Probleme in Sprachen erkennen, die über die oben aufgeführten hinausgehen. Weitere Informationen finden Sie unter [AUTOTITLE](/code-security/code-quality/responsible-use/code-quality).
    

Wo werden Ergebnisse angezeigt?

Wenn Sie ein Repository für Code Quality aktiviert haben, sehen Sie CodeQL-Scans für:

  • Jede neue Pullanforderung, die mit der Standardverzweigung geöffnet wird
  • Alle bestehenden Pullanforderungen an der Standardverzweigung werden bei ihrer Aktualisierung aktualisiert, wodurch ein neuer Lauf der CI-Tests ausgelöst wird.
  • Die gesamte Codebasis auf der Standardverzweigung zu Uhrzeit und Datum, die auf der Einstellungsseite "Codequalität" angezeigt wird

Darüber hinaus sehen Sie eine KI-basierte Analyse aller letzten Push-Vorgänge an der Standardverzweigung.

Ergebnisse der Pull Request

Wenn CodeQL regelbasierte Probleme bei Pull Requests findet, sehen Sie Kommentare von github-code-quality[bot]. Wenn möglich, enthält jeder Kommentar einen Copilot Autofix Vorschlag zur Behebung des Problems. Weitere Informationen findest du unter Beheben von Codequalität-Feststellungen, bevor Sie Ihren Pull Request zusammenführen.

Standard-Zweig-Ergebnisse

          Code Quality Ergebnisse auf der Standardverzweigung werden aufCodequalität den Seiten auf der **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality** Registerkarte für das Repository gemeldet:

* ** Standardergebnisse ** zeigt die Ergebnisse der CodeQL Qualitätsanalyse an. Weitere Informationen findest du unter Verbessern der Qualität des Codes Ihres Repositorys. * ** KI-Ergebnisse ** zeigt die Ergebnisse der KI-basierten Analyse der Dateien, die zuletzt an den Standard-Branch übertragen wurden. Weitere Informationen findest du unter Verbesserung der Qualität von kürzlich zusammengeführten Codes durch KI.

Scaninformationen

Jede CodeQL-Analyse verwendet GitHub Actions Minuten und kann auf dem Aktionen-Tab des Repository als dynamischer "Codequalität" Workflow-Lauf angezeigt werden.

Nächste Schritte

  •         **Für Ihr Repository:** Aktivieren Sie, Code Quality um mit dem Generieren von Ergebnissen zu beginnen. Weitere Informationen findest du unter [AUTOTITLE](/code-security/how-tos/maintain-quality-code/enable-code-quality).
    
  •         **Für Ihr Unternehmen:** Stellen Sie sicher, dass Repositories in Ihrem Unternehmen aktiviert werden könnenCode Quality. Weitere Informationen findest du unter [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise).