Documentation

Vérifications, exécutions et résultats

Lire une exécution de vérification, trier les constatations et décider des actions à entreprendre.

Une vérification est une vérification unique. Une exécution correspond à une exécution des vérifications dans une politique appliquée à un changement. Une constatation est ce qu'une vérification a rapporté.

Trouvez-les sous Qualité → Exécutions et Qualité → Constatations.

Lire une exécution

Une exécution affiche chaque vérification, son résultat et sa sortie. Lorsqu'une tâche échoue à la vérification, c'est dans l'exécution que vous découvrirez la raison.

Lisez-le du haut vers le bas. La première vérification en échec est généralement la cause réelle ; les échecs ultérieurs sont souvent des conséquences. Un échec de compilation suivi de douze échecs de test constituent un seul problème, pas treize.

Constatations

Les constatations proviennent d'agents de révision, de scanneurs et de portes d'admission. Chacune indique ce qui a été trouvé, où et son niveau de gravité.

Leur cycle de vie :

  1. Signalée par une vérification ou un réviseur.
  2. Routée — les constatations pouvant être corrigées sont renvoyées à l'agent développeur pour retravail ; les autres sont associées à pull request.
  3. Résolue — corrigée, acceptée ou supprimée.

Trier

La question pour chaque constatation n'est pas « est-ce vrai ? » mais « cela change-t-il ce qui se passe ensuite ? ».

  • Corriger maintenant — correction de bugs, sécurité, tout ce qui échouerait à la révision de toute façon.
  • Accepter — constatation vraie mais ne méritant pas d'action ici. Notez la raison.
  • Supprimer — faux positif, ou règle ne s'appliquant pas à ce code.

Supprimez délibérément et en indiquant une raison. Une suppression non expliquée est indiscernable de quelqu'un qui étouffe une vérité gênante ; six mois plus tard, personne ne pourra distinguer l'une de l'autre.

Lorsqu'il y a trop de constatations

Le volume est un signal sur la configuration, pas sur la qualité du code.

Une vérification déclenchée sur la plupart des changements ne détecte pas de problèmes ; elle décrit simplement votre base de code. Soit la règle ne correspond pas à vos conventions, soit elle décrit une dette technique que vous avez choisi d'accepter. Dans les deux cas, la vérification est mal configurée.

Constatations et portes

Une constatation issue d'une porte d'avis est une information. La même constatation issue d'une porte bloquante arrête la tâche. La constatation est identique ; la politique détermine son impact.

C'est la solution à utiliser lorsqu'une vérification est correcte mais trop agressive : modifiez sa gravité plutôt que de la supprimer. Consultez Politiques de qualité et portes.