Enabling debug logging

Si les journaux de workflow ne fournissent pas suffisamment de détails pour diagnostiquer la raison pour laquelle un workflow, un travail ou une étape ne fonctionne pas comme prévu, vous pouvez activer une journalisation de débogage supplémentaire.

Dans cet article

Note

Les exécuteurs hébergés sur GitHub ne sont pas pris en charge sur GitHub Enterprise Server. Vous pouvez voir plus d’informations sur le support futur planifié dans la GitHub public roadmap.

Ces journaux supplémentaires sont activés en définissant des secrets ou des variables dans le référentiel contenant le workflow, de sorte que les mêmes exigences en matière d’autorisations s'appliquent :

  • Pour créer des secrets ou des variables sur GitHub pour un référentiel de compte personnel, vous devez être le propriétaire du référentiel. Pour créer des secrets ou des variables sur GitHub pour un référentiel d’une organisation, vous devez disposer d’un accès admin. Enfin, pour créer des secrets ou des variables pour un référentiel de compte personnel ou un référentiel d’organisation via l’API REST, vous devez disposer d’un accès collaborateur.
  • Pour créer des secrets pour un environnement dans un référentiel de compte personnel, vous devez être le propriétaire du référentiel. Pour créer des secrets ou des variables pour un environnement dans un référentiel d’organisation, vous devez disposer d’un accès admin. Pour plus d’informations sur les environnements, consultez « Gestion des environnements pour le déploiement ».
  • Les propriétaires d’organisations peuvent créer des secrets ou des variables au niveau de l’organisation.

Pour plus d’informations sur la configuration des secrets et des variables, consultez « Utilisation de secrets dans GitHub Actions » et « Stocker des informations dans des variables ».

De plus, toute personne disposant d’un accès pour exécuter un workflow peut activer la journalisation des diagnostics de l’exécuteur et la journalisation du débogage par étape pour une réexécution de workflow. Pour plus d’informations, consultez « Ré-exécution de workflows et de travaux ».

Activation de la journalisation des diagnostics de l’exécuteur

La journalisation des diagnostics de l’exécuteur fournit des fichiers journaux supplémentaires qui contiennent des informations sur la façon dont un exécuteur exécute un travail. Deux fichiers journaux supplémentaires sont ajoutés à l’archive des journaux :

  • Journal du processus de l’exécuteur, qui inclut des informations sur la coordination et la configuration des exécuteurs pour exécuter des travaux.
  • Journal du processus de travail, qui enregistre l’exécution d’un travail.
  1. Pour activer la journalisation des diagnostics de l’exécuteur, définissez le secret ou la variable suivant dans le dépôt qui contient le workflow : ACTIONS_RUNNER_DEBUG à true. Si le secret et la variable sont définis, la valeur du secret est prioritaire sur la variable.
  2. Pour télécharger les journaux des diagnostics de l’exécuteur, téléchargez l’archive des journaux de l’exécution de workflow. Les journaux des diagnostics de l’exécuteur sont contenus dans le dossier runner-diagnostic-logs. Pour plus d’informations sur le téléchargement des journaux, consultez « Using workflow run logs ».

Activation de la journalisation du débogage par étape

La journalisation du débogage par étape augmente la verbosité des journaux d’un travail pendant et après l’exécution d’un travail.

  1. Pour activer la journalisation du débogage des étapes, définissez le secret ou la variable suivante dans le référentiel qui contient le workflow : ACTIONS_STEP_DEBUG à true. Si le secret et la variable sont définis, la valeur du secret est prioritaire sur la variable.
  2. Après avoir défini le secret ou la variable, d’autres événements de débogage sont affichés dans les journaux d’étapes. Pour plus d’informations, consultez « Using workflow run logs ».