À propos des vérifications d’état

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.

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 les vérifications d’état sont requises pour un référentiel, elles doivent passer avant de pouvoir fusionner votre branche dans la branche protégée. Pour plus d’informations, consultez « À propos des branches protégées ».

Types de vérifications de statut sur GitHub

Il existe deux types de vérifications de statut sur GitHub :

• Vérifications

• États de validation

          _Les vérifications_ sont différentes des _statuts de validation_ dans la mesure où elles fournissent des annotations de ligne et des messages plus détaillés et sont utilisables uniquement avec GitHub Apps.
  

Les propriétaires et les utilisateurs de l’organisation disposant d’un accès push à un dépôt peuvent créer des vérifications et des statuts de validation avec l’API de GitHub. Pour plus d’informations, consultez « Points de terminaison d’API REST pour les vérifications » et « Points de terminaison d’API REST pour les états de commit ».

Vérifications

Les pull requests ont un onglet Vérifications où vous pouvez consulter en détail la sortie de build des checks et réexécuter les checks échoués.

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.

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 dépôt n’est pas défini pour demander automatiquement des vérifications pour les envois push, vous pouvez demandes des vérifications pour une validation individuelle que vous envoyez. Pour en savoir plus sur ces paramètres, consultez Points de terminaison d’API REST pour les suites de 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.

Statuts de vérification et conclusions

Les vérifications peuvent avoir de nombreux statuts différents. Les statuts décrivent l’état d’une vérification de sa création à son achèvement. Certains statuts ne peuvent pas être définis manuellement et sont réservés pour GitHub Actions. Lorsqu’une vérification affiche le statut completed, elle a une conclusion. La conclusion décrit le résultat de la vérification. L’ensemble des statuts de vérification et conclusions possibles sont répertoriés ci-dessous.

Statut	Description	GitHub Actions uniquement ?
completed	L’exécution de la vérification s’est achevée et a une conclusion (voir ci-dessous).	Non
expected	L’exécution de la vérification attend qu’un statut soit signalé.	Oui
failure	L’exécution de la vérification a échoué.	Non
in_progress	L’exécution de la vérification est en cours.	Non
pending	L’exécution de la vérification se trouve au début de la file d’attente, mais la limite de concurrence basée sur un groupe a été atteinte.	Oui
queued	L’exécution de la vérification a été mise en file d’attente.	Non
requested	L’exécution de la vérification a été créée, mais n’a pas été mise en file d’attente.	Oui
startup_failure	La suite de vérifications a échoué pendant le démarrage. Ce statut n’est pas applicable aux exécutions de vérification.	Oui
waiting	L’exécution de la vérification attend qu’une règle de protection de déploiement soit satisfaite.	Oui

Conclusion	Description
action_required	L’exécution de la vérification a fourni les actions requises à son achèvement. Pour plus d’informations, consultez « Utilisation de l’API REST pour interagir avec des vérifications ».
cancelled	L’exécution de la vérification a été annulée avant son achèvement.
failure	L’exécution de la vérification a échoué.
neutral	L’exécution de la vérification s’est achevée avec un résultat neutre. Cela est considéré comme un succès pour les vérifications dépendantes dans GitHub Actions.
skipped	L’exécution de la vérification a été ignorée. Cela est considéré comme un succès pour les vérifications dépendantes dans GitHub Actions.
stale	L’exécution de la vérification a été marquée comme périmée par GitHub, car elle a pris trop de temps.
success	L’exécution de la vérification s’est achevée avec succès.
timed_out	L’exécution de la vérification a expiré.

Conservation des vérifications

GitHub 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.