Skip to main content

À propos de la page d’état de l’outil

La page page d’état de l’outil offre une vue d'ensemble sur l'état et les performances des outils code scanning de votre dépôt.

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 Advanced Security activé.

Qu’est-ce que page d’état de l’outil ?

Le page d’état de l’outil affiche des informations sur tous vos outils code scanning et constitue un bon point de départ pour dépanner lorsque code scanning ne fonctionne pas comme prévu.

Remarque

Le page d’état de l’outil affiche l’état de l’outil uniquement au niveau du référentiel pour la branche par défaut, et non au niveau de l’organisation.

Indicateurs d’état de l’outil

Le page d’état de l’outil affiche l’un des trois états suivants :

  •         **Toutes les configurations fonctionnent** : tous les outils fonctionnent comme prévu
    
  •         **Certaines configurations ont besoin d’attention : certains** outils présentent des avertissements ou des problèmes non critiques
    
  •         **Certaines configurations ne fonctionnent pas** : un ou plusieurs outils présentent des erreurs critiques
    

Quelles informations sont disponibles

Pour tous les outils code scanning

  • État et santé de la configuration
  • Planification de l’analyse
  • Premières et dernières heures d’analyse
  • Règles utilisées dans les analyses

Pour les outils intégrés tels que CodeQL

Outre les informations répertoriées ci-dessus, page d’état de l’outil pour les outils intégrés fournit les détails suivants :

  • Pourcentages de couverture de fichiers par langage de programmation
  • Détails de configuration pour chaque type d’installation
  • Messages d’erreur spécifiques
  • Rapports CSV téléchargeables de fichiers analysés
  • Listes téléchargeables des règles utilisées et des nombres d’alertes

Comment CodeQL définit les fichiers analysés

CodeQL considère un fichier comme analysé si des lignes de code de ce fichier ont été traitées.

Langages interprétés

  •         **Configuration par défaut** : les fichiers scannés incluent tous les fichiers de code source pour les langages de programmation que CodeQL sont capables d'analyser
    
  •         **Configuration avancée** : vous pouvez utiliser `paths` et `paths-ignore` définir les fichiers à analyser. Consultez [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql).
    

Langues compilées

La page d'état de l'outil page d’état de l’outil signale les fichiers présents avant l'exécution des étapes de génération automatique ou manuelle. Les fichiers générés pendant le processus de génération ne sont pas affichés. Consultez Analyse CodeQL pour les langages compilés.

Calcul de couverture

Les pourcentages de couverture des fichiers respectent tous les fichiers exclus par paths et les paths-ignore propriétés de configuration.

Comprendre les pourcentages de couverture des fichiers

Utilisez des pourcentages de couverture de fichiers pour déboguer et améliorer votre analyse :

  •         **Pourcentage élevé** : Code scanning fonctionne comme prévu pour cette langue
    
  •         **Pourcentage faible** : Examiner le résultat du diagnostic. Consultez [AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected)
    
  •         **Pourcentage zéro** : vous pouvez avoir du code dans les langues qui ne sont pas actuellement analysées. Mettez à jour votre configuration pour inclure ces langues. Consultez [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#changing-the-languages-that-are-analyzed)
    

Remarque

Si vous configurez l’installation avancée et la configuration par défaut, page d’état de l’outil affiche uniquement la configuration par défaut.

Fonctionnalités de résolution des problèmes

Le page d’état de l’outil vous aide à résoudre les problèmes par le biais de :

  •         **Messages d’erreur** : explique pourquoi les outils ne fonctionnent pas comme prévu avec les actions suggérées
    
  •         **Données de couverture des** fichiers : indique les fichiers et les langues en cours d’analyse
    
  •         **Détails de la configuration** : affiche des informations sur chaque exécution d’analyse
    
  • Rapports téléchargeables : fournit des rapports CSV avec des informations détaillées sur les fichiers et les règles

Lectures complémentaires

  •         [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/use-the-tools-status-page-for-code-scanning)