Skip to main content

À propos des vérifications d’état

Les vérifications d’état vous indiquent si vos commits remplissent les conditions définies pour le dépôt auquel vous contribuez.

Les vérifications d’état sont basées sur des processus externes, tels que des builds d’intégration continue, qui s’exécutent pour chaque envoi (push) que vous effectuez vers un référentiel. Vous pouvez voir l’état en attente, en cours de passage ou en échec des vérifications d’état en regard des validations individuelles dans votre demande de tirage.

Capture d’écran d’une liste de commits et d’états.

Toute personne disposant d’autorisations d’écriture dans un référentiel peut définir l’état pour toute vérification d’état dans le référentiel.

Vous pouvez afficher l’état global de la dernière validation sur une branche sur la page des branches de votre référentiel ou dans la liste des demandes de tirage.

Si des vérifications d’état sont requises pour un référentiel, vous devez effectuer celles-ci avant de pouvoir fusionner votre branche dans la branche protégée. Pour plus d’informations, consultez « À propos des branches protégées ».

Remarque : Un travail ignoré signale son état comme « Réussite ». Il n’empêche pas une demande de tirage (pull request) de fusionner, même s’il s’agit d’une vérification requise.

Types de vérifications d’état sur GitHub

Il existe deux types de vérifications d’état sur GitHub :

  • Vérifications
  • États

Les vérifications sont différentes des états car elles fournissent des annotations de ligne, une messagerie plus détaillée et sont uniquement disponibles pour une utilisation avec GitHub Apps.

Les propriétaires et les utilisateurs de l’organisation disposant d’un accès d’envoi (push) à un référentiel peuvent créer des vérifications et des états avec l’API de GitHub. Pour plus d’informations, consultez « Points de terminaison d’API REST pour les vérifications » et « Commits ».

Vérifications

Lorsque des vérifications sont configurées dans un référentiel, les demandes de tirage ont un onglet Vérifications dans lequel vous pouvez afficher la sortie détaillée de build à partir des vérifications d’état et réexécuter les vérifications ayant échoué.

Remarque : l’onglet Vérifications est rempli uniquement pour les demandes de tirage si vous configurez des vérifications et non des états, pour le référentiel.

Lorsqu’une ligne spécifique d’une validation entraîne l’échec d’une vérification, vous verrez des détails sur la défaillance, l’avertissement ou l’avis en regard du code approprié sous l’onglet Fichiers de la demande de tirage.

Vous pouvez parcourir les récapitulatifs des vérifications de différents commits dans une demande de tirage en utilisant le menu déroulant des commits sous l’onglet Vérifications.

Capture d’écran de l’onglet « Vérifications » d’une demande de tirage. L’onglet « Vérifications » et le menu déroulant permettant de sélectionner un commit sont tous deux indiqués en orange foncé.

Ignorer et demander des vérifications pour les validations individuelles

Lorsqu’un référentiel est défini pour demander automatiquement des vérifications pour les envois push, vous pouvez choisir d’ignorer les vérifications pour une validation individuelle que vous envoyez. Lorsqu’un référentiel n’est pas défini pour demander automatiquement des vérifications pour les envois push, vous pouvez choisir d’ignorer les vérifications pour une validation individuelle que vous envoyez. Pour plus d’informations sur ces paramètres, consultez « Points de terminaison d’API REST pour les vérifications ».

Vous pouvez également ignorer les exécutions de workflow déclenchées par les événements push et pull_request en incluant une commande dans votre message de commit. Pour plus d’informations, consultez « Exécutions de workflow ignorées ».

Sinon, pour ignorer ou demander toutes les vérifications pour votre commit, ajoutez l’une des lignes de code de fin suivantes à la fin de votre message de commit :

  • Pour ignorer des vérifications pour une validation, entrez votre message de validation ainsi qu’une description courte et explicite de vos modifications. Après la description de votre validation, avant de fermer la quotation, ajoutez deux lignes vides suivies de skip-checks: true :

    $ git commit -m "Update README
    >
    >
    skip-checks: true"
    
  • Pour demander des vérifications pour une validation, entrez votre message de validation ainsi qu’une description courte et explicite de vos modifications. Après la description de votre validation, avant de fermer la quotation, ajoutez deux lignes vides suivies de request-checks: true :

    $ git commit -m "Refactor usability tests
    >
    >
    request-checks: true"
    

Par défaut, Git supprime automatiquement les sauts de ligne consécutifs. Pour laisser le message de validation exactement comme vous l’avez saisi, utilisez l’option --cleanup=verbatim sur votre validation. Pour plus d’informations, consultez --cleanup=<mode> dans la documentation Git.

Conservation des vérifications d’état

GitHub.com conserve les données de vérification pendant 400 jours. Au terme des 400 jours, les données sont archivées. 10 jours après l’archivage, les données sont définitivement supprimées.

Pour fusionner une demande de tirage avec des vérifications à la fois obligatoires et archivées, vous devez réexécuter les vérifications.