Exploration des résultats de la qualité du code GitHub dans votre organisation

Logiciels requis

• Si votre organisation appartient à une entreprise, un propriétaire d’entreprise doit activer Code Quality pour votre organisation. Consultez « Autoriser l’utilisation de GitHub Code Quality dans votre entreprise ».
• Votre organisation doit disposer de référentiels avec Code Quality activé. Consultez « Activation de GitHub Code Quality ».

Affichage des analyses de qualité du code pour votre organisation

Le tableau de bord au niveau de l’organisation comporte deux onglets :

• L’onglet Intégrité affiche un instantané de l’intégrité actuelle du code de votre organisation.
• L’onglet Tendances montre comment les résultats ouverts ont changé sur une période sélectionnée, afin de pouvoir suivre la progression et identifier les référentiels qui ont besoin d’attention.

1. Sur GitHub, accédez à la page principale de votre organisation. Par exemple, à partir de https://github.com/settings/organizations.
2. Sous le nom de votre organisation, cliquez sur l’onglet Security and quality .
3. Dans la section « Insights » de la barre latérale, cliquez sur Qualité du code.

Filtrage des données de tableau de bord

Une barre de filtre en haut du tableau de bord s’applique aux onglets Intégrité et Tendances . Vous pouvez filtrer par :

• Score de fiabilité
• Score de maintenance
• Résultats standard
• Résultats de l’IA
• Sujet
• Équipe
• Visibilité
• Toutes les propriétés personnalisées définies pour votre organisation

Vous pouvez également trier les données du tableau de bord à l’aide du contrôle Trier dans la même barre de filtre.

Consulter l’état de santé actuel du code

L’onglet Intégrité affiche un instantané de l’intégrité du code de votre organisation pour l’instant.

Interprétation du graphique de la distribution des scores

Le graphique de distribution de score fournit une vue d’ensemble visuelle de l’intégrité du code de votre organisation. Chaque bulle représente une collection de référentiels avec les mêmes scores de maintenance et de fiabilité.

• La position de chaque bulle illustre l’intégrité globale de ces référentiels. Les bulles plus élevées représentent des scores de facilité de maintenance plus élevés, tandis que les bulles plus à droite représentent des scores de fiabilité plus élevés.
• La couleur et le modèle de bordure d’une bulle indiquent la gravité du score inférieur pour ces dépôts. Par exemple, une bulle avec un score « Pauvre » dans l’une ou l’autre catégorie sera toujours rouge avec une bordure pointillée.
• La taille de chaque bulle représente le nombre de référentiels avec cette combinaison de scores particulière.

Pour afficher le score de maintenance, le score de fiabilité et le nombre de référentiels représentés par une bulle particulière, pointez sur la bulle.

Exploration de la table du référentiel

Sous le graphique en bulles, il existe un tableau qui répertorie tous les référentiels de votre organisation. Ici, vous pouvez afficher les résultats de qualité du code, ainsi que des informations plus détaillées sur ces résultats.

Vous pouvez trier la table du référentiel dans l’ordre croissant ou décroissant de n’importe quelle colonne en cliquant sur l’en-tête de colonne.

Examen des référentiels à faible score

1. Pour filtrer les données du tableau de bord pour les référentiels les moins performants, sur le graphique de distribution des scores, cliquez sur le point avec les scores combinés les plus bas.
2. Faites défiler jusqu’à la table du référentiel. Par défaut, la table est triée du scan du référentiel le plus récent au moins récent, ce qui vous aide à hiérarchiser les problèmes de qualité actuels.
3. Si vous le souhaitez, pour hiérarchiser les référentiels avec le plus grand nombre de CodeQL résultats, cliquez Résultats standard deux fois.
4. Pour afficher le tableau de bord au niveau du référentiel pour un référentiel spécifique, cliquez sur le nom du référentiel.

Suivi des tendances de qualité au fil du temps

L’onglet Tendances montre comment ouvrir les résultats entre les référentiels auxquels vous avez accès et qui correspondent aux filtres actuels ont changé au fil du temps. Vous pouvez donc déterminer si votre travail de qualité du code a un effet et où concentrer l’attention suivante.

1. Dans le tableau de bord au niveau de l’organisation, cliquez sur l’onglet Tendances .
2. Utilisez la liste déroulante Période pour sélectionner un intervalle de temps : les 7, 14 ou 30 derniers jours.
3. Passez en revue le graphique « Résultats ouverts au fil du temps », qui indique le nombre total de résultats ouverts dans les référentiels applicables pour la période sélectionnée.
4. Si vous le souhaitez, utilisez les boutons au-dessus du graphique pour regrouper les données par score de santé ou gravité.
5. Survolez un point du graphique pour voir le nombre de résultats ouverts pour ce jour.

Présentation des données de tendances

Gardez à l’esprit ce qui suit lorsque vous interprétez le graphique :

• Le graphique est basé sur des instantanés quotidiens des résultats ouverts. Si aucune analyse n’a été exécutée le jour donné, il se peut qu’il n’y ait aucun point de données pour ce jour-là.

• Les données historiques ne sont disponibles qu’au démarrage Code Quality de la prise d’instantanés, de sorte que l’intervalle de temps disponible peut initialement être limité.

• Le graphique suit le nombre total de résultats ouverts, et non les résultats individuels ouverts ou corrigés. Une modification du nombre ne signifie pas nécessairement que les développeurs ont résolu ou introduit des problèmes.

• L’activation Code Quality sur des référentiels supplémentaires peut augmenter le nombre de recherche indiqué dans le graphique. Une augmentation après l’activation de nouveaux référentiels ne signifie pas nécessairement que la qualité du code diminue.

• Le graphique suit le nombre total de résultats ouverts pour les référentiels sur lesquelles vous filtrez actuellement. Le nombre total comprend :

  • Nouvelles découvertes introduites par des modifications de code ou lorsque l’analyse de la qualité du code est activée sur de nouveaux référentiels
  • Constatations corrigées dans le code ou rejetées par les utilisateurs

Identification des référentiels qui ont besoin d’attention

Sous le graphique des tendances, deux tableaux vous aident à identifier les référentiels qui ont besoin d’attention sur la période sélectionnée :

• La plupart des référentiels améliorés répertorient les dépôts avec la plus grande diminution des résultats ouverts au cours de la période sélectionnée.
• Les référentiels nécessitant une amélioration répertorient les référentiels avec la plus grande augmentation des résultats ouverts au cours de la période sélectionnée.

Les deux tableaux incluent les colonnes suivantes :

• Référentiel : nom du référentiel.
• Total ouvert : nombre de résultats ouverts pour le référentiel à la fin de la période sélectionnée.
• Modification nette : comment le nombre de recherche ouvert pour le référentiel a changé au cours de la période sélectionnée.
• Rejetés: nombre de résultats rejetés dans le dépôt au cours de la période sélectionnée.

Le nombre de constatations pour un dépôt est influencé par le fait que des constatations sont corrigées ou rejetées. Vous pouvez utiliser le tableau de bord au niveau du référentiel pour confirmer ce qui a changé.

Pour examiner un référentiel, cliquez sur son nom pour ouvrir son tableau de bord au niveau Code Quality du référentiel, où vous pouvez passer en revue les résultats individuels et prendre des mesures correctives.

Étapes suivantes

Pour comprendre les informations d’intégrité du code disponibles sur le tableau de bord au niveau du référentiel, consultez Interprétation des résultats de qualité du code pour votre référentiel.

Si vous envisagez d’activer Code Quality dans de nombreux référentiels, consultez Déployer GitHub Code Quality à grande échelle.