Définition des seuils de qualité du code pour les pull requests

Créez une barrière Code Quality pour les pull requests afin d'améliorer la qualité du code fusionné dans votre dépôt.

Qui peut utiliser cette fonctionnalité ?

Propriétaires de référentiels, propriétaires d’organisations et utilisateurs avec le rôle d’administrateur

GitHub Team ou GitHub Enterprise Cloud

Dans cet article

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.

Présentation

Vous pouvez bloquer les pull requests qui ne respectent pas vos normes de qualité du code en ajoutant la règle de branche Require code quality results à un jeu de règles et en spécifiant le niveau de gravité requis. Si un pull request n'atteint pas ce seuil, il ne peut pas être intégré.

Prerequisites

Remarque

Le seuil aura un impact uniquement si le référentiel possède du code dans une ou plusieurs langues prises en charge, consultez Activation de GitHub Code Quality.

Confirmer que Code Quality s’exécute correctement sur les pull requests

Avant d’ajouter ou de mettre à jour un ensemble de règles pour inclure un seuil pour Code Quality, vérifiez que le flux de travail Qualité du code est en cours d’exécution et signale les résultats aux pull requests. Sinon, le jeu de règles peut bloquer la fusion de toutes les pull requests.

  1. Ouvrez une demande de tirage récente et faites défiler jusqu’au résumé « Vérifications » en bas de la demande de tirage.
  2. Vérifiez que la vérification « CodeQL - Qualité du code » s’est exécutée correctement et a signalé son état.

Pour plus d’informations, consultez « Analyse basée sur CodeQL pour la qualité du code ».

Ajout ou mise à jour d’un jeu de règles pour inclure Code Quality

  1. Accédez à l’onglet « Paramètres » de votre référentiel.
  2. Dans la barre latérale gauche, sous « Code and automation », développez Rules (Règles), puis cliquez sur Rulesets (ensembles de règles).
  3. Si vous ne disposez pas déjà d’un ensemble de règles pour protéger votre branche par défaut, développez Nouveau jeu de règles , puis cliquez sur Nouveau ensemble de règles de branche. Vous pouvez également ouvrir votre ensemble de règles existant pour la branche par défaut et passer à l’étape 5.
  4. Si vous créez un ensemble de règles :
    • Définissez un nom pour l’ensemble de règles.
    • Définissez « État de l’application » sur « Actif ».
    • Sous « Branches cibles », ajoutez une cible de « Inclure une branche par défaut ».
  5. Sous « Règles de branche », activez « Exiger des résultats de qualité du code ».
  6. Définissez « Severity » pour indiquer le niveau de gravité minimal des résultats de qualité du code qui doivent être résolus avant qu’une pull request puisse être fusionnée dans la branche par défaut. Par exemple:
    • Définissez « Erreurs » pour bloquer les pull requests contenant des erreurs de qualité du code non résolues avant leur fusion.
    • Définissez « Warnings and higher » pour bloquer la fusion des pull requests contenant des avertissements ou des erreurs non résolus.
    • Définissez « Notes and higher » pour bloquer la fusion des pull requests contenant des remarques, des avertissements ou des erreurs non résolus.
    • Définissez « All » pour bloquer la fusion des pull requests contenant n’importe quels résultats de qualité du code non résolus.
  7. Une fois que vous avez terminé de définir ou de modifier l’ensemble de règles, cliquez sur Créer ou Enregistrer des modifications.

Étapes suivantes

Découvrez comment GitHub Code Quality fonctionne dans les pull requests pour empêcher les problèmes de qualité du code d’atteindre votre branche par défaut. Consultez Correction des problèmes de qualité du code avant de fusionner votre pull request.