Skip to main content

Setting exit codes for actions

Vous pouvez utiliser des codes de sortie pour définir l’état d’une action. GitHub affiche des états pour indiquer la réussite ou l’échec des actions.

À propos des codes de sortie

GitHub utilise le code de sortie pour définir l’état de vérification de l’exécution de l’action, qui peut être success ou failure.

État de sortieVérifier l’état de l’exécutionDescription
0successL’action s’est terminée correctement et d’autres tâches qui en dépendent peuvent démarrer.
Valeur différente de zéro (tous les entiers, sauf 0)failureTout autre code de sortie indique que l’action a échoué. En cas d’échec d’une action, toutes les actions simultanées sont annulées et les actions futures sont ignorées. L’exécution de la vérification et la suite de vérification obtiennent toutes les deux l’état failure.

Configuration d’un code de sortie d’échec dans une action JavaScript

Si vous créez une action JavaScript, vous pouvez utiliser le package @actions/core du kit de ressources d’actions afin de journaliser un message et configurer un code de sortie d’échec. Par exemple :

try {
  // something
} catch (error) {
  core.setFailed(error.message);
}

Pour plus d’informations, consultez « Creating a JavaScript action ».

Configuration d’un code de sortie d’échec dans une action de conteneur Docker

Si vous créez une action de conteneur Docker, vous pouvez définir un code de sortie d’échec dans votre script entrypoint.sh. Par exemple :

if <condition> ; then
  echo "Game over!"
  exit 1
fi

Pour plus d’informations, consultez « Creating a Docker container action ».