Remarque
GitHub Code Quality est actuellement en préversion publique et sera disponible de façon générale le 20 juillet 2026.
Pendant préversion publique, Code Quality ne sera pas facturé, bien que les analyses Code Quality consomment des minutes GitHub Actions. À partir du 20 juillet 2026, l’utilisation entraîne des frais. Consultez « GitHub Code Quality Facturation ».
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. Vous pouvez également appliquer des seuils de couverture avec des ensembles de règles pour bloquer les demandes de tirage qui ne répondent pas à un pourcentage de couverture minimal ou qui entraînent la chute de la couverture par plus que le montant autorisé.
- Téléchargez les rapports de couverture du code pour voir les indicateurs de couverture des tests directement dans les pull requests, ce qui aide les relecteurs à identifier le code non testé.
- Affectez facilement le travail de correction à Agent cloud Copilot, 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 est actuellement en préversion publique et sera disponible de manière générale le 20 juillet 2026. Pendant préversion publique, les analyses Code Quality consommeront GitHub Actions minutes, mais vous ne serez pas facturé pour toute autre utilisation. À partir du 20 juillet 2026, l’utilisation entraîne des frais supplémentaires. Consultez « GitHub Code Quality Facturation ».
Si vous souhaitez éviter les frais, désactivez-les Code Quality avant le 20 juillet 2026. Consultez « Désactivation GitHub Code Quality ».
Remarque
Vous n’avez pas besoin d’une licence Copilot ou Code Security pour utiliser Code Quality ou appliquer les correctifs automatiques alimentés par Copilot.
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 « Carte de l’application : fonctionnalités d’IA GitHub pour la sécurité et la qualité ».
Où apparaîtront les résultats ?
Une fois que vous aurez 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 correction automatique 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 ».
Si vous avez configuré la couverture de code, le github-code-quality[bot] publie également un résumé de couverture indiquant le pourcentage global de couverture de la branche de PR par rapport à la branche par défaut. Consultez « Interprétation des résultats de qualité du code pour votre référentiel ».
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 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 flux de travail dynamique « Qualité du code ».
Comment l’accompagnement fonctionne à l’échelle de votre entreprise
Code Quality est contrôlé à trois niveaux, de sorte que vous pouvez décider de la quantité d’autonomie pour donner aux organisations et aux dépôts :
- Entreprise : Un propriétaire d’entreprise doit d’abord autoriser Code Quality pour l’entreprise. Tant qu’ils ne le font pas, les propriétaires de l’organisation ne peuvent pas l’activer.
- Organisation : Les propriétaires de l’organisation contrôlent les référentiels pour lesquels Code Quality est activé ou désactivé, en accordant l’accès à tous les référentiels, à une liste précise ou à des référentiels correspondant à un filtre. Ils peuvent également appliquer ces paramètres afin que les administrateurs de référentiel ne puissent pas les modifier.
- Dépôt : Les administrateurs de dépôts peuvent activer ou désactiver Code Quality pour des dépôts individuels, sauf si une application au niveau de l’organisation est en vigueur.
Lorsque Code Quality est activé pour un dépôt, l’analyse CodeQL s’exécute via GitHub Actions et affiche les résultats dans les pull requests et sur la branche par défaut. Les développeurs voient les vérifications de qualité et les annotations sur leurs pull requests.
Accès au référentiel au niveau de l’organisation
Au niveau de l’organisation, vous contrôlez Code Quality avec un seul paramètre d’accès référentiel . Ce paramètre détermine les référentiels activés et ceux qui l’ont Code Quality désactivé : les référentiels de votre sélection sont activés et les référentiels en dehors de votre sélection sont désactivés.
Important
La modification du paramètre d’accès au référentiel peut activer et désactiver Code Quality plusieurs référentiels à la fois. Par exemple, si vous activez Code Quality les référentiels correspondant à un filtre, tout référentiel qui ne correspond pas au filtre est désactivé. Avant l’application de votre modification, une boîte de dialogue affiche le nombre total de référentiels activés et désactivés, ainsi que l’impact sur la facturation.
Options d’accès au référentiel
Vous pouvez appliquer l’une des options suivantes à la fois.
| Option | Behavior |
|---|---|
| Aucun référentiel | Désactive Code Quality pour tous les dépôts actuels et futurs de l’organisation. |
| Laisser les dépôts décider | L’organisation n’active ni ne désactive Code Quality. Les administrateurs de référentiels choisissent s’ils doivent l’activer pour leurs propres dépôts. Cette option ne peut pas être appliquée. |
| Tous les référentiels | Active Code Quality pour tous les référentiels actuels et futurs. |
| Référentiels sélectionnés | Permet d’activer Code Quality pour une liste spécifique de dépôts que vous sélectionnez. Les dépôts que vous ne sélectionnez pas sont désactivés et les nouveaux référentiels ne sont pas activés automatiquement. Convient mieux aux projets pilotes ou aux exceptions. |
| Correspondant à un filtre | Active les référentiels Code Quality qui correspondent à un filtre que vous définissez, maintenant et à l’avenir. Les référentiels qui ne correspondent pas sont désactivés. Consultez les référentiels de filtrage. |
Filtrage des référentiels
Lorsque vous choisissez Mise en correspondance d’un filtre, vous créez un filtre dynamique qui active automatiquement les dépôts existants et futurs qui correspondent à vos critères Code Quality . Cela est utile pour la gouvernance continue à grande échelle.
Vous pouvez filtrer sur n’importe quelle combinaison des critères suivants :
- Visibilité : Indique si les référentiels sont publics, privés ou internes. Utile pour des politiques globales, comme l’activation de Code Quality pour tous les dépôts privés.
- Statut du fork : Si les dépôts sont des forks. Utile lorsque les forks ne doivent pas consommer de ressources d’analyse.
- Propriété personnalisée : Indique si les référentiels ont une valeur de propriété personnalisée spécifique. Par exemple, vous pouvez cibler des référentiels avec une
team:platformpropriété.
Toutes les conditions d’un filtre sont combinées avec AND: un référentiel doit donc correspondre à chaque condition à activer. Vous pouvez également exclure les référentiels qui correspondent à des conditions spécifiques.
Contrôle de l’accès
Par défaut, les administrateurs de référentiels peuvent modifier Code Quality les paramètres de leurs propres référentiels. Pour éviter cela, activez Forcer l’accès.
Verrous d’application dans les états activés et désactivés définis par votre option d’accès au référentiel , afin que les administrateurs de référentiel ne puissent pas les remplacer. Cela améliore la cohérence au sein de votre organisation, mais réduit la flexibilité pour les administrateurs de référentiels individuels.
- Cette règle s’applique à la plupart des options de accès au dépôt que vous sélectionnez, y compris Aucun dépôt, ce qui force Code Quality à être désactivé.
- L’application de cette règle n’est pas possible avec Laisser les référentiels décider, car ce paramètre laisse intentionnellement le choix aux administrateurs des référentiels.
Planification de votre déploiement
Étant donné que l’activation Code Quality peut affecter plusieurs référentiels à la fois et chaque analyse consomme des GitHub Actions minutes, planifiez la façon dont vous la déployez dans votre organisation :
- Commencez par un groupe pilote. Activez d’abord un petit ensemble représentatif de référentiels, par exemple en les sélectionnant individuellement ou en correspondant à une propriété personnalisée, afin de pouvoir valider les résultats avant de les développer.
- Vérifiez votre GitHub Actions capacité. Vérifiez que vos coureurs peuvent absorber la charge supplémentaire avant d’activer Code Quality largement.
- Déterminez si vous souhaitez imposer l’activation. L’application stricte vous offre une couverture uniforme et empêche les administrateurs du dépôt de s’y soustraire, mais elle leur enlève toute flexibilité. Laisser la mise en application désactivée durant une phase pilote permet aux équipes d’y adhérer ou de s’en retirer à mesure qu’elles apprennent.
- Étendez une fois les résultats jugés fiables. Une fois que vous avez confirmé que l’analyse s’exécute en douceur et que les développeurs comprennent les résultats, élargissez votre sélection ou filtre pour couvrir davantage de dépôts.
Étapes suivantes
- Pour votre dépôt ou votre organisation : Activez la génération Code Quality des résultats. Consultez « Activation de GitHub Code Quality ».
- Pour votre entreprise : Vérifiez que les dépôts de votre entreprise peuvent être activés Code Quality. Consultez « Autoriser l’utilisation de GitHub Code Quality dans votre entreprise ».