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.
Comprendre pourquoi votre requête de pull est bloquée
Les administrateurs de référentiel peuvent définir des portes de qualité du code pour la maintenabilité et la fiabilité à l'aide de GitHub Code Quality. Lorsque vous créez un pull request, une analyse s’exécute automatiquement pour vérifier vos modifications par rapport à ces normes.
Si votre demande de tirage introduit du code qui tombe en dessous du seuil de qualité requis, vous verrez une bannière de bloc de fusion en bas de la demande de tirage dans la section Vérifications : « La fusion est bloquée : les résultats de la qualité du code ont été détectés ».
Ces vérifications permettent de maintenir une base de code saine et gérable et d’empêcher l’accumulation de dettes techniques.
Affichage des résultats de l’analyse et de leurs niveaux de gravité
Les résultats de l’analyse sont présentés sous forme de commentaires sur votre requête pull, laissés par le github-code-quality[bot]. Chaque commentaire correspond à un problème de qualité de code spécifique détecté dans vos modifications.
Les commentaires sont étiquetés par gravité (Erreur, Avertissement, Remarque). Pour en savoir plus sur ce que signifient les niveaux de gravité, consultez Niveaux de gravité.
Déterminer quels constats bloquent votre pull request
La porte de qualité définie par les administrateurs de référentiel définit le niveau de gravité minimal qui bloquera la fusion.
La bannière de bloc de fusion peut spécifier le niveau de gravité minimal. Toutes les constatations à ce niveau de gravité ou supérieur doivent être traitées avant de pouvoir fusionner votre requête pull.
Remarque
Si vous ne voyez pas de niveau de gravité défini dans la bannière de bloc de fusion, cela signifie que votre dépôt utilise les seuils de qualité de code les plus stricts, ce qui nécessite que toutes les conclusions soient traitées avant la fusion.
Correction ou rejet de chaque recherche
Pour débloquer votre pull request, vous devez résoudre chaque problème identifié en déterminant s’il faut résoudre le problème dans votre code ou ignorer le commentaire.
Tirer parti de Copilot Autofix et agent Copilot de cloud pour corriger les découvertes
Copilot Autofix
Les commentaires sur le pull request incluent une autocorrection suggérée que vous pouvez commettre directement dans votre pull request. Examinez attentivement la correction automatique suggérée pour la logique, la sécurité et le style, puis cliquez sur Valider la suggestion.
Vous n’avez pas besoin d’une licence Copilot pour appliquer ces suggestions.
agent Copilot de cloud
Sinon, si vous disposez d’une Copilot licence, vous pouvez déléguer le travail de correction à agent Copilot de cloud. Commentez la pull request en mentionnant @Copilot et demandez à Copilot de corriger les problèmes détectés.
Copilot répond avec un émoji de yeux (👀) à votre commentaire, démarre une nouvelle session pour l'agent et ouvre un pull request avec les correctifs nécessaires.
Vous pouvez suivre agent Copilot de cloudle travail :
- Dans le pull request, le résumé est mis à jour à mesure de l'avancement du travail.
- À l’aide de la page des agents ou des journaux de session, consultez Suivi des sessions de GitHub Copilot.
Vous avez besoin d’une Copilot licence pour appeler agent Copilot de cloud.
S’inscrire Copilot
Rejeter le constat
Vous pouvez ignorer une recherche si elle n’est pas pertinente ou actionnable dans le contexte de votre codebase. Les raisons courantes d’ignorer une recherche sont les suivantes :
- La découverte se trouve dans le code ancien qui n’est plus maintenu.
- Il s’agit d’une exception connue des normes de codage de votre équipe.
- C’est un faux positif qui ne pose pas de risque de qualité réelle.
Si vous ignorez les alertes non pertinentes, vos vérifications de qualité se concentrent sur des problèmes significatifs.
Vérification que vous avez satisfait aux exigences
Pour voir si vous avez satisfait aux exigences de qualité du code, consultez la section « Vérifications » en bas de votre demande de tirage. La bannière de bloc de fusion ne doit plus être présente et vous devez être en mesure de fusionner vos modifications comme d’habitude.
Étapes suivantes
Réduisez la dette technique en corrigeant les résultats dans les fichiers récemment modifiés. Consultez Amélioration de la qualité du code récemment fusionné avec l’IA.