À propos de la qualité du code sur GitHub

Remarque

GitHub Code Quality est actuellement dans préversion publique et peut être modifié. Pendant préversion publique, Code Quality ne sera pas facturé, bien que les analyses Code Quality consomment GitHub Actions minutes.

Aperçu

          GitHub Code Quality vous permet de vous assurer que votre codebase est fiable, gérable et efficace. Que vous créez une nouvelle fonctionnalité, réduisez la dette technique ou signalez sur l’intégrité des référentiels, Code Quality fournit des insights exploitables et des correctifs automatisés pour vous permettre d’améliorer et de maintenir efficacement l’intégrité du code de votre dépôt.

Fonctionnalités et avantages clés

Avec Code Quality, vous pouvez :

Identifiez les risques et les opportunités de qualité du code dans les demandes de tirage et par le biais d’analyses de référentiel.
Passez en revue des explications claires pour les résultats et appliquez des correctifs automatiques activés d'un simple clicCopilot.
Utilisez des tableaux de bord de référentiel pour suivre les scores de fiabilité et de maintenance, identifier les domaines nécessitant de l’attention et hiérarchiser la correction.
Surveillez les tableaux de bord de l’organisation pour comprendre l’intégrité du code de vos référentiels en un clin d’œil et déterminer les référentiels à examiner plus en détail.
Mettez en place des règles pour les pull requests afin d'appliquer des normes de qualité du code et de bloquer les modifications qui ne répondent pas à vos critères.
Affectez facilement le travail de correction à agent Copilot de cloud, si vous disposez d’une Copilot licence.

Coûts de disponibilité et d’utilisation

          GitHub Code Quality est disponible pour les référentiels appartenant à l'organisation sur les plans GitHub Team et GitHub Enterprise Cloud.

          GitHub Code Quality ne sera pas facturé lors de l'aperçu public. Toutefois, Code Quality les analyses consomment GitHub Actions minutes. Consultez « [AUTOTITLE](/billing/concepts/product-billing/github-code-quality) ».

Remarque

Vous n’avez pas besoin d’une licenceCopilot ou Code Security pour utiliser Code Quality ou appliquer Copilotdes correctifs automatiques.

Langues prises en charge

          Code Quality effectue une analyse basée sur des règles des langues suivantes à l'aide de CodeQL :

C#
Go
Java
JavaScript
Python
Ruby

TypeScript

        Code Quality effectue également une analyse basée sur l’IA avec des résultats affichés séparément sur le tableau de bord du référentiel «**Résultats de l’IA** ». Contrairement à l’analyse basée sur des règles CodeQL qui examine l’intégralité du code source et des demandes de tirage, cette analyse basée sur l’IA n'examine que les fichiers récemment poussés à la branche par défaut et peut identifier des problèmes dans des langages au-delà de ceux mentionnés ci-dessus. Pour plus d’informations, consultez « [AUTOTITLE](/code-security/code-quality/responsible-use/code-quality) ».

Où apparaîtront les résultats ?

Une fois que vous avez activé Code Quality pour un dépôt, vous verrez CodeQL analyses pour :

Chaque nouvelle pull request ouverte contre la branche par défaut
Toutes les demandes de tirage (pull request) existantes vers la branche par défaut lorsqu’elles sont mises à jour, ce qui déclenche une nouvelle exécution des tests CI
Base de code entière sur la branche par défaut à l’heure et à la date affichées dans la page des paramètres «Qualité du code »

En outre, vous verrez une analyse basée sur l’IA de tous les push récents vers la branche par défaut.

Résultats de la demande de tirage

Lorsque CodeQL trouve des problèmes basés sur des règles sur les pull requests, vous verrez des commentaires de github-code-quality[bot]. Si possible, chaque commentaire inclut une Copilot Autofix suggestion sur la façon de résoudre le problème. Consultez « Correction des problèmes de qualité du code avant de fusionner votre pull request ».

Résultats de branche par défaut

          Code Quality les résultats de la branche par défaut sont signalés sur les pages «Qualité du code » sous l’onglet **<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** du référentiel :

* ** Résultats standard ** affiche les résultats de l’analyse de qualité CodeQL. Consultez « Amélioration de la qualité du code de votre référentiel ». * ** Résultats de l’IA ** affiche les résultats de l’analyse basée sur l’IA des fichiers les plus récemment envoyés vers la branche par défaut. Consultez « Amélioration de la qualité du code récemment fusionné avec l’IA ».

Analyser les informations

Chaque CodeQL analyse prendra GitHub Actions minutes et peut être vue dans l'onglet Actions du référentiel en tant qu'exécution du «Qualité du code» flux de travail dynamique.

Étapes suivantes

        **Pour votre référentiel :** Activez la génération Code Quality des résultats. Consultez « [AUTOTITLE](/code-security/how-tos/maintain-quality-code/enable-code-quality) ».

        **Pour votre entreprise :** Vérifiez que les dépôts de votre entreprise peuvent être activés Code Quality. Consultez « [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise) ».