Procédure pas à pas : ajout d'étapes de génération à l'aide de la tâche BuildStep
Mise à jour : novembre 2007
Une tâche BuildStep est une tâche MSBuild écrite spécifiquement pour Team Foundation Server. Vous ajoutez une tâche BuildStep à une génération en ajoutant un ou plusieurs éléments BuildStep à un élément Target dans le fichier TFSBuild.proj de la définition de build de la solution.
Composants requis
Avant de pouvoir ajouter une tâche BuildStep à une définition de build, vous devez disposer des éléments suivants :
Accès au fichier TFSBuild.proj pour la définition de build que vous voulez personnaliser. Pour plus d'informations sur la création de définitions de build, consultez Comment : créer une définition de build.
.gif "Remarque importante")
Remarque importante :Lorsque vous personnalisez le fichier TFSBuild.proj, vous personnalisez chaque définition de build qui lui est associée.
Espace de travail local qui contient les fichiers de votre projet d'équipe et les fichiers de build. Pour plus d'informations, consultez Comment : créer un espace de travail mappé et Comment : obtenir la source de votre projet d'équipe.
Autorisations requises
Pour exécuter les procédures de cette rubrique, les autorisations Archiver et Extraire doivent avoir la valeur Autoriser. Pour plus d'informations, consultez Autorisations de Team Foundation Server.
Pour ajouter des étapes de génération à l'aide de la tâche BuildStep, exécutez les procédures suivantes :
Ajout d'une tâche au fichier projet
Ajout d'une étape de génération informative au fichier projet
Ajout d'une tâche au fichier projet
Vous pouvez utiliser la tâche BuildStep pour ajouter et mettre à jour des étapes de génération. Cette procédure explique comment modifier le fichier TFSBuild.proj comme suit :
Ajoutez une étape de génération.
Effectuez une tâche.
Mettez à jour l'étape de génération avec l'état Opération réussie si la tâche a réussi ou avec l'état Échec dans le cas contraire.
La tâche d'étape de génération de l'exemple copie des fichiers sources vers un nouvel emplacement.
Pour ajouter et mettre à jour une étape de génération dans le fichier TFSBuild.proj
Démarrez Visual Studio.
Extrayez du contrôle de version Team Foundation le fichier TFSBuild.proj que vous voulez modifier et ouvrez-le dans l'éditeur XML de Visual Studio.
Ajoutez le code XML suivant à l'élément <ItemGroup>. Vous pouvez ajouter le code XML à l'élément <ItemGroup> existant ou décider d'ajouter un nouvel élément <ItemGroup> :
.gif "Remarque")
Remarque :Le code de cette étape identifie les dossiers dans lesquels se trouvent les fichiers sources à copier. D'autres tâches MSBuild peuvent requérir d'autres ajouts au code XML. Pour plus d'informations sur les exigences associées aux tâches MSBuild, consultez Référence des tâches MSBuild.
<ItemGroup> <SourceFileFolder Include="C:\WorkingFolder\TeamBuildTypes\**\*.cs" /> </ItemGroup>Ajoutez le code XML suivant à la fin du fichier TFSBuild.proj, juste avant l'élément </Project> :
</ItemGroup> <Target Name="BeforeCompile"> <BuildStep TeamFoundationServerUrl="$(TeamFoundationServerUrl)" BuildUri="$(BuildUri)" Message="Working..."> <Output TaskParameter="Id" PropertyName="StepId" /> </BuildStep> <!-- Perform a task... --> <Copy SourceFiles="@(SourceFileFolder)" DestinationFolder="C:\NewSourceFileFolder" /> <BuildStep TeamFoundationServerUrl="$(TeamFoundationServerUrl)" BuildUri="$(BuildUri)" Id="$(StepId)" Status="Succeeded" /> <OnError ExecuteTargets="MarkBuildStepAsFailed" /> </Target> <Target Name="MarkBuildStepAsFailed"> <BuildStep TeamFoundationServerUrl="$(TeamFoundationServerUrl)" BuildUri="$(BuildUri)" Id="$(StepId)" Status="Failed" /> </Target> </Project>Remarque :Pour plus d'informations sur les cibles Team Foundation Build et la liste des cibles personnalisables, consultez Cibles Team Foundation Build personnalisables.
Enregistrez les modifications apportées, puis fermez TFSBuild.proj.
Archivez le fichier TFSBuild.proj dans le contrôle de version.
Exécutez la définition de build.
Pour plus d'informations, consultez Comment : démarrer ou mettre en file d'attente une définition de build.
Vous pouvez afficher le message associé à l'étape de génération dans l'Build Explorer, et vous pouvez voir la création complète de l'étape de génération et les processus de mise à jour dans le journal de génération. Vous pouvez également voir les fichiers copiés dans le répertoire que vous avez spécifié. Pour plus d'informations, consultez Comment : surveiller la progression de la génération.
Ajout d'une étape de génération informative au fichier projet
Si vous n'avez pas à exécuter une tâche mais que vous voulez ajouter une étape de génération informative, n'utilisez pas la propriété Id Output et définissez immédiatement l'état. Cette procédure ajoute uniquement un message au processus de génération qui s'affiche quand vous ouvrez la build dans l'Build Explorer.
Pour ajouter une étape de génération informative au fichier TFSBuild.proj
Démarrez Visual Studio.
Extrayez du contrôle de version Team Foundation le fichier TFSBuild.proj que vous voulez modifier et ouvrez-le dans l'éditeur XML de Visual Studio.
Ajoutez le code XML suivant à la fin du fichier TFSBuild.proj, juste avant la balise </Project> :
</ItemGroup> <Target Name="AfterCompile"> <BuildStep TeamFoundationServerUrl="$(TeamFoundationServerUrl)" BuildUri="$(BuildUri)" Message="Compile step complete." Status="Succeeded" /> </Target> </Project>Remarque :Pour plus d'informations sur les cibles Team Foundation Build et la liste des cibles personnalisables, consultez Cibles Team Foundation Build personnalisables.
Enregistrez les modifications apportées, puis fermez TFSBuild.proj.
Archivez le fichier TFSBuild.proj dans le contrôle de version.
Exécutez la définition de build.
Pour plus d'informations, consultez Comment : démarrer ou mettre en file d'attente une définition de build.
Vous pouvez afficher le message dans l'Build Explorer et dans le journal de génération. Pour plus d'informations, consultez Comment : surveiller la progression de la génération.