Skip to main content

Utiliser la page d’état de l’outil pour l’analyse du code

Affichez l'état de l'outil en temps réel, identifiez les problèmes de configuration et téléchargez des rapports pour que l'analyse de votre code scanning fonctionne sans problème.

Qui peut utiliser cette fonctionnalité ?

Utilisateurs avec accès en écriture

Code scanning est disponible pour les types de référentiels suivants :

  • Des référentiels publics sur GitHub.com
  • Référentiels appartenant à l’organisation sur GitHub Team, GitHub Enterprise Cloud, ou GitHub Enterprise Server, avec GitHub Code Security activé.

Le page d’état de l’outil affiche des informations sur tous vos outils d’analyse de code et constitue un bon point de départ pour le débogage des problèmes. Pour plus d’informations sur l’outil et les informations qu’il fournit, consultez À propos de la page d’état de l’outil.

Affichage de la page d’état de l’outil pour un dépôt

La page des alertes code scanning de chaque référentiel présente une bannière d’outils résumant l’état de santé de votre analyse de scan de code, ainsi qu’un accès à la page page d’état de l’outil pour examiner votre configuration.

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom du référentiel, cliquez sur Sécurité. Si vous ne voyez pas l’onglet « Sécurité », sélectionnez le menu déroulant et cliquez sur Sécurité.

    Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Sécurité » est mis en évidence avec un encadré orange foncé.

  3. Dans la barre latérale gauche, cliquez sur Code scanning.

  4. Cliquez sur État de l’outil dans la bannière Outils.

           ![Capture d’écran montrant comment accéder à la page État de l’outil à partir d’un dépôt. Le bouton « État de l’outil » est mis en évidence avec un contour orange foncé.](/assets/images/help/repository/code-scanning-tool-status-page-access.png)
    

Utilisation de la page d’état de l’outil

Dans la page d’état de l’outil, vous voyez un résumé d’un outil, mis en évidence dans la barre latérale. Vous pouvez utiliser la barre latérale pour afficher les résumés de différents outils.

Capture d’écran montrant la page d’état de l’outil, avec l’outil CodeQL sélectionné.

Pour les outils intégrés tels que CodeQL, vous pouvez voir un pourcentage total de tous les fichiers les plus récemment analysés dans votre dépôt, organisés par langage de programmation. Vous pouvez également télécharger des rapports de langage détaillés au format CSV. Consultez Téléchargement des détails des fichiers analysés.

Accès à des informations détaillées sur les outils

Si vous souhaitez voir des informations plus détaillées sur l’outil affiché, vous pouvez sélectionner une configuration spécifique sous « Types de configuration ».

Sous « Configurations » à gauche de l’écran, vous pouvez voir des informations pour chaque analyse exécutée par ce type de configuration, ainsi que tous les messages d’erreur pertinents. Pour afficher des informations détaillées sur l’exécution d’analyse la plus récente, sélectionnez une configuration dans la barre latérale. Vous pouvez télécharger les détails des règles qui ont été exécutées dans cette analyse du code et le nombre d’alertes trouvées par chaque règle. Pour plus d’informations, consultez Téléchargement de listes de règles utilisées.

Capture d’écran montrant des informations détaillées sur CodeQL dans la page d’état de l’outil.

Cette vue affiche également les messages d’erreur. Pour plus d’informations, consultez Débogage avec la page État de l’outil.

Téléchargement des détails des fichiers analysés

Pour les outils intégrés tels que CodeQL, vous pouvez télécharger des rapports détaillés à partir de la page d’état de l’outil au format CSV. Les informations indiquées sont les suivantes :

  • Quelle configuration a été utilisée pour analyser chaque fichier
  • Chemin d’accès au fichier
  • Langage de programmation du fichier
  • Indique si le fichier a été extrait avec succès

Pour télécharger un rapport, sélectionnez un outil qui vous intéresse. Ensuite, en haut à droite de la page, cliquez sur le bouton .

Téléchargement de listes de règles utilisées

Vous pouvez télécharger la liste des règles que l’code scanning vérifie, au format CSV. Les informations indiquées sont les suivantes :

  • Configuration utilisée
  • Source de la règle
  • Identificateur SARIF
  • Nombre d’alertes trouvées

Pour télécharger un rapport, sélectionnez une configuration qui vous intéresse. Cliquez ensuite sur en haut à droite de la page, puis sélectionnez Télécharger la liste des règles utilisées.

Suppression de configurations

Vous pouvez supprimer des configurations obsolètes, en double ou indésirables pour la branche par défaut de votre dépôt.

Pour supprimer une configuration, sélectionnez la configuration que vous souhaitez supprimer. Cliquez ensuite sur en haut à droite de la page, puis sélectionnez Supprimer la configuration. Une fois que vous avez lu l’avertissement relatif aux alertes, pour confirmer la suppression, cliquez sur le bouton Supprimer.

Remarque

Vous ne pouvez utiliser que la page d’état de l’outil pour supprimer des configurations de la branche par défaut d’un référentiel. Pour plus d’informations sur la suppression de configurations de branches autres que la branche par défaut, consultez Résoudre les alertes d'analyse de code.

Débogage à l’aide de la page d’état de l’outil

Si vous constatez un problème avec votre analyse à partir de la page d’alertes d’code scanning, vous pouvez utiliser la page d’état de l’outil pour identifier le problème. Pour les outils intégrés, vous pouvez voir des messages d’erreur spécifiques dans la section des informations détaillées, liés à des outils d’code scanning spécifiques. Ces messages d’erreur contiennent des informations sur la raison pour laquelle l’outil peut ne pas fonctionner comme prévu et sur les actions que vous pouvez effectuer. Pour plus d’informations sur l’accès à cette section de la page d’état de l’outil, consultez Accès à des informations détaillées sur les outils.

Pour les outils intégrés tels que CodeQL, vous pouvez également utiliser les informations de couverture des fichiers pour améliorer votre analyse. Pour plus d’informations sur l’interprétation des pourcentages de couverture des fichiers, consultez À propos de la page d’état de l’outil.

Pour plus d’informations, consultez « Résolution des erreurs d’analyse du code » et « Résolution des problèmes de téléchargements SARIF ».