Skip to main content

Journaux insuffisamment détaillés

Accroître la verbosité des journaux et générer des artefacts de débogage si ces derniers manquent de détails de diagnostic.

Si vos journaux d’activité ne sont pas suffisamment détaillés pour résoudre un problème, vous pouvez effectuer plusieurs étapes pour obtenir des informations supplémentaires et rendre les journaux plus utiles.

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.

Pour activer la journalisation du débogage par étapes :

  1. Dans le référentiel qui contient le flux de travail, définissez le secret ou la variable suivante : ACTIONS_STEP_DEBUG``true Si le secret et la variable sont tous les deux définis, la valeur du secret prévaut sur celle de la variable.
  2. Réexécutez le flux de travail ou déclenchez une nouvelle exécution.

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. Consultez « Utilisation des journaux d’exécution de flux de travail ».

Vous pouvez également utiliser le contexte runner.debug pour exécuter des étapes de manière conditionnelle uniquement lorsque la journalisation du débogage est activée. Consultez « Référence des contextes ».

Création de CodeQLartefacts de débogage

Avertissement

CodeQL les artefacts de débogage contiennent une copie du code source analysé par CodeQL, par conséquent, nous vous suggérons de partager ces bundles uniquement avec des personnes autorisées à accéder à ce code source.

Vous pouvez obtenir des artefacts pour vous aider à déboguer CodeQL. Les artefacts de débogage seront chargés dans l'exécution du flux de travail en tant qu’artefacts avec des noms commençant par debug-artifacts. Si CodeQL plusieurs langues sont analysées simultanément dans le cadre de l’exécution du flux de travail, il existe un artefact de ce type pour chaque langue. Les données contiennent les journaux, les bases de données, CodeQL les CodeQL fichiers de code source extraits et tous les fichiers SARIF générés par le flux de travail. Pour plus d’informations sur le téléchargement des CodeQL artefacts, consultez Téléchargement d’artéfacts de workflow.

Ces artefacts vous aideront à déboguer des problèmes avec CodeQLcode scanning. Si vous contactez Support GitHub, ils peuvent demander ces données.

Création d’artefacts CodeQL de débogage pour CodeQL la configuration par défaut

Vous pouvez créer CodeQL des artefacts de débogage en activant la journalisation de débogage des étapes (voir Activation de la journalisation de débogage des étapes) et en déclenchant une nouvelle CodeQL analyse, par exemple en poussant un nouveau commit vers une branche de pull request.

Si vous avez accordé CodeQL l’accès aux registres privés, des artefacts supplémentaires dont les noms commencent proxy-log-file par seront disponibles. Ils contiennent des journaux d’activité du proxy d’authentification utilisé par défaut pour CodeQL authentifier les demandes auprès des registres privés et peuvent être utilisés pour résoudre les problèmes de configurations de Registre privé. Pour en savoir plus, veuillez consulter la section Accès des fonctionnalités de sécurité aux registres privés.

Création d’artefacts CodeQL de débogage pour CodeQL une configuration avancée

Les artefacts de débogage pour la configuration avancée CodeQL peuvent être obtenus de différentes manières.

Réexécuter les travaux avec la journalisation de débogage activée

L’option la plus simple pour créer des artefacts de débogage dans le cadre d’une configuration avancée CodeQL consiste à réexécuter des tâches avec la journalisation de débogage activée. Pour plus d’informations sur la réexécutation GitHub Actions des flux de travail et des travaux, consultez Ré-exécution de workflows et de tâches.

Vous devez veiller à sélectionner Activer la journalisation du débogage. Cette option permet d’activer la journalisation des diagnostics de l’exécuteur et la journalisation du débogage par étape pour l’exécution. Vous pourrez ensuite télécharger les CodeQL artefacts de débogage pour approfondir l’analyse. Vous n’avez pas besoin de modifier le fichier de flux de travail lors de la création CodeQL d’artefacts de débogage en réexécutant des travaux.

Utilisation d’un indicateur de flux de travail

Vous pouvez créer CodeQL des artefacts de débogage à l’aide d’un indicateur dans votre flux de travail. Pour cela, vous devez modifier l’étape init de votre Workflow d’analyse CodeQL fichier et définir debug: true.

- name: Initialize CodeQL
  uses: github/codeql-action/init@v4
  with:
    debug: true

Utilisation de la journalisation du débogage pas à pas avec GitHub Actions

Si vous activez la journalisation de débogage des étapes GitHub Actions, CodeQL génère également des artefacts de débogage et les téléverse dans le cadre de l’exécution du flux de travail. Pour obtenir des instructions, consultez Activation de la journalisation du débogage pas à pas.