Gérer des informations sur les builds et contrôler les commentaires

Vous pouvez obtenir les types d'informations suivants sur une build terminée :

• Comment la génération s'est-elle déroulée ? La génération a-t-elle réussi ? Quand a-t-elle commencé ? Quelle est la durée de la génération ? Comment cette génération est-elle comparable aux générations précédentes ?

• Qu'est ce qui a été généré ? Quelles solutions, ensembles de modifications et résolutions de bogue ont été intégrés dans cette génération ?

• Qu'est-ce qui s'est mal passé ? Quels avertissements ou quelles erreurs se sont produits ? Quels tests ont échoué ?

Vous pouvez contrôler systématiquement le niveau de commentaire des informations stockées sur chaque build terminée lorsque vous définissez votre processus de génération. Vous pouvez également gérer ces commentaires pour une seule exécution de génération lorsque vous la mettez en file d'attente manuellement.

Dans cette rubrique

• Présentation de la génération des informations et de son déroulement

  • Définir le processus de génération

  • Processus de génération mis en file d'attente et exécuté

  • Informations de génération générées, filtrées et stockées

  • Extraire les informations de génération

• Définition du paramètre de consignation des commentaires du processus de génération

• Meilleure pratique : Définissez le niveau de commentaires le plus faible possible

  • Utiliser le niveau minimum de commentaires en exécutant une génération

  • Utiliser le niveau minimum de commentaires pour concevoir un modèle de processus de génération personnalisé

• Pour plus d'informations

Présentation de la génération des informations et de son déroulement

Définir le processus de génération

Vous pouvez contrôler systématiquement le niveau de commentaires lorsque vous développez votre processus de génération. Lorsque vous créez ou modifiez une définition de build basée sur DefaultTemplate.xaml ou UpgradeTemplate.xaml, affichez l'onglet Processus. Dans le nœud Basic, vous pouvez sélectionnez une valeur dans la liste Commentaires de journalisation pour spécifier ce paramètres du processus de génération.

Dans les cas où les modèles intégrés ne répondent pas à vos besoins, vous pouvez développer un modèle de processus de génération personnalisé. Lorsque vous créez ce genre de modèle, vous devez soigneusement écrire les informations de build. Pour plus d'informations, consultez Gérer le volume de commentaires de votre modèle de processus de génération personnalisé.

Processus de génération mis en file d'attente et exécuté

Vous pouvez redéfinir manuellement le paramètre Commentaires de journalisation lorsque vous mettez en file d'attente une définition de build basée sur DefaultTemplate.xaml ou UpgradeTemplate.xaml. Dans la boîte de dialogue Mettre en file d'attente la build, affichez l'onglet Paramètres, développez le nœud Basic, puis sélectionnez une valeur dans la liste Commentaires de journalisation pour spécifier les paramètres du processus de génération. Cette valeur est appliquée à une seule exécution de la build.

Informations de génération générées, filtrées et stockées

Le système de génération passe la valeur du paramètre Verbosity du processus de génération à Verbosity. Cette propriété est utilisée pour filtrer les informations de build consignées et stockées dans l'entrepôt de données via Information à partir des sources suivantes :

• Activités du flux de travail : Plusieurs activités de flux de travail génèrent un message lorsqu'une opération se déroule correctement ou un message d'avertissement ou d'erreur lorsqu'une opération échoue. Par exemple, l'activité SyncWorkspace génère des messages de faible importance lorsqu'elle télécharge le code source et d'autres fichiers du serveur vers l'agent de build. Cette activité génère des erreurs lorsque l'opération de téléchargement échoue. Autre exemple : l'activité OpenWorkItem génère un message d'avertissement lorsque la création de l'élément de travail échoue.

  Vous pouvez utiliser d'autres activités de flux de travail pour écrire vos propres informations de build. Pour plus d'informations, consultez la rubrique Créer un modèle de processus de génération personnalisé qui écrit des informations avec un volume de commentaires nécessaires minimum.

• MSBuild  : Le processus de génération utilise l'activité MSBuild pour tirer parti de MSBuild pour compiler les fichiers binaires et pour effectuer d'autres tâches essentielles. La propriété Verbosity de cette activité gère le volume des commentaires que ce processus génère et publie aux emplacements suivants :

  • L'entrepôt de données stocke les résultats, les erreurs et les avertissements de la compilation.

  • Un journal dans le dossier de dépôt stocke les mêmes informations que l'entrepôt de données avec également tous les autres messages que produit MSBuild.

• MSTest : Le processus de génération utilise l'activité MSTest pour tirer parti du fichier MSTest.exe afin d'exécuter les tests. Tous les messages générés par ce processus sont classés avec un ordre d'importance élevé et publiés dans l'entrepôt de données et dans un journal du dossier de dépôt.

Extraire les informations de génération

Pendant et à l'issue de l'exécution de la build, vous pouvez extraire le résumé et les informations détaillées dans la fenêtre d'affichage des résultats de génération. Vous pouvez copier ces informations de la fenêtre dans le Presse-papiers. Vous pouvez également établir un lien direct avec le dossier de dépôt pour extraire des journaux, des fichiers binaires et d'autres données.

Paramètre de processus de génération de consignation des commentaires

Dans un processus de génération basé sur DefaultTemplate.xaml ou UpgradeTemplate.xaml, vous pouvez utiliser le paramètre Commentaires de journalisation du processus de génération pour gérer le volume des informations à consigner et stocker.

Le tableau suivant répertorie les valeurs des commentaires de journalisation et les effets correspondants :

Valeur	Erreurs	Avertissements	Messages de la build d'importance élevée	Messages d'importance normale	Messages de faible importance	Propriétés d'activité de workflow (entrées et sorties)
Minimum	Y	N	N	N	N	N
Normal	Y	Y	Y	N	N	N
Détaillé	Y	Y	Y	Y	N	N
Diagnostic (doit être généralement utilisé uniquement pour déboguer un processus de génération)	Y	Y	Y	Y	Y	Y

Meilleure pratique : Définissez le niveau de commentaires le plus faible possible

Même si les informations de génération sont importantes, un processus de génération qui stocke un volume d'informations trop élevé peut produire des erreurs. Parmi ces problèmes, on peut citer l'utilisation élevée d'un espace de stockage dans l'entrepôt de données, la réduction des performances de Visual Studio et la saturation des membres de l'équipe avec une quantité d'informations difficile à gérer.

Utiliser le niveau minimum de commentaires en exécutant une génération

Lorsque vous exécutez une génération, vous devez généralement respecter les meilleures pratiques en utilisant le paramètre de commentaires le plus faible qui fournit quand même les informations nécessaires pour atteindre votre objectif.

Par exemple, vous pouvez exécuter une build afin de générer des fichiers binaires qui incluent les modifications du code les plus récentes. Dans la plupart des cas, le paramètre Normal est suffisant. Toutefois, vous pouvez être amené à utiliser le paramètre Détaillé ou Diagnostic si vous dépannez un problème de bogue du processus de génération ou une erreur de compilation de code inhabituelle.

Utiliser le niveau minimum de commentaires pour concevoir un modèle de processus de génération personnalisé

Les utilisateurs de votre processus de génération comptent sur le filtre des commentaires pour réduire la saturation d'informations. Vous pouvez rendre ce filtrage plus efficace en prenant les mesures suivantes :

• Assurez-vous que vous sélectionnez l'activité la plus appropriée pour écrire un message : Activité WriteBuildMessage, Activité WriteBuildWarning ou Activité WriteBuildError.

• Lorsque vous utilisez l'activité Activité WriteBuildMessage pour consigner des informations, appliquez une méthode intentionnelle et cohérente pour définir la propriété Importance. Lorsque vous utilisez une valeur d'importance plus élevée pour votre message, sachez que vous augmentez potentiellement le volume de données stockées et présentées aux membres de l'équipe.

Notes

L'impact de ces décisions peut être particulièrement spectaculaire si vous utilisez ces activités à l'intérieur d'une structure de boucle, comme DoWhile, ForEach<T> ou While.

Pour plus d'informations

Activités Team Foundation Build décrit les activités de flux de travail du processus de génération abordées dans cette rubrique.

Définir une build à l'aide du modèle par défaut et Définir une build à l'aide du modèle de mise à niveau fournissent des instructions sur la création d'une définition de build.

Afficher la fenêtre Résultats de la génération fournit des instructions sur le mode d'utilisation de la fenêtre d'affichage des résultats de génération.

IBuildDetail, BuildMessageImportance et BuildVerbosity décrivent certains éléments clés de l'API de Team Foundation Build qui fournissent la fonctionnalité des informations de génération.

Référence de la ligne de commande MSBuild décrit MSBuild.

Spécifier les raisons et les déclencheurs de build et Mettre une build en file d'attente décrivent comment mettre une génération en file d'attente automatiquement et manuellement.

Historique des modifications

Date	Historique	Motif
Avril 2011	Ajout d'une rubrique.	Améliorations apportées aux informations.