Partager via

Définir les tâches pour traiter un plug-in

  • Article

Vous utilisez l'élément tasks et ses éléments enfants pour définir les artefacts à télécharger ou des éléments spécifiques à créer pour un plug-in. Une tâche spécifie le travail à effectuer pour configurer un élément spécifique au processus d'un nouveau projet d'équipe. Plusieurs tâches que vous définissez téléchargent les types d'éléments de travail, les requêtes d'élément de travail, les documents et les rapports pour un projet d'équipe. D'autres tâches que vous pouvez définir configurent d'autres domaines de Visual Studio Application Lifecycle Management, tels que Team Foundation Build, Visual Studio Lab Management, le Gestionnaire de tests et le contrôle de version Team Foundation.

Dans cette rubrique

  • Structure de la syntaxe des tâches

  • Référence des éléments de tâches

  • Index des éléments taskXML par fonction

  • Exemple : définition de types d'éléments de travail

Structure de la syntaxe des tâches

Vous pouvez spécifier plusieurs tâches dans un plug-in, et ces tâches peuvent être interdépendantes. Les tâches que vous définissez pour chaque plug-in doivent être conformes à la définition de schéma tasks, défini dans le fichier Tasks.xsd, et être spécifiées dans leur propre fichier à l'aide de l'élément conteneur tasks.

La syntaxe suivante illustre la structure générale de l'élément tasks et de ses éléments enfants.

<tasks>
   <task>
      <dependencies>
        <dependency />
        . . .    
      </dependencies />
      <taskXml>
        . . .    
      </taskXml>
   <task/>
</tasks>

Retour au début

Référence des éléments de tâches

Le tableau suivant décrit chaque élément qui peut définir les tâches d'un plug-in.

Élément

Syntaxe

Description

dependencies

 
<dependencies>
<dependency>. . . </dependency>
</dependencies>

Élément enfant facultatif de task.

Spécifie d'autres groupes dont un groupe dépend.

dependency

 
<dependency taskId="taskId" />

Élément enfant facultatif de dependencies.

Spécifie l'ID d'une autre tâche dont dépend cette tâche. L'autre tâche doit s'exécuter pour que cette tâche puisse démarrer.

ProcessTemplate

 
<ProcessTemplate Type="FileType" Filename="LocalPathAndFileName" 
   Description="FileDescription" 
   ServerPath="UploadLocation" />

Où chaque attribut est défini comme suit :

  • Type : type de fichier en cours de téléchargement. Les valeurs suivantes sont valides : Default et Upgrade pour les fichiers modèles de build et Custom pour les fichiers modèles lab.

  • Filename : nom et chemin d'accès au répertoire local du fichier à télécharger.

  • Description : brève chaîne de texte qui décrit le fichier à télécharger.

  • ServerPath : chemin du serveur qui exécute Team Foundation Server où le fichier doit être téléchargé. Le seul emplacement valide pour le téléchargement est $/$$PROJECTNAME$$/BuildProcessTemplates.

Élément enfant facultatif de l'élément taskXml pour les plug-ins Build et Lab.

Spécifie le nom, l'emplacement et la destination d'un fichier à télécharger pour prendre en charge les processus de génération d'un projet d'équipe.

task

 
<task id="task id" name="name of task" 
   plugin="Microsoft.ProjectCreationWizard.<PluginName>" 
   completionMessage="SuccessfulCompletionMessage" 
   completionDescription="InProcessMessage">
    <dependencies>. . . </dependencies>
    <taskXml>. . . </taskXml>
</task>

Élément enfant obligatoire de tasks.

Spécifie le travail à effectuer pour configurer un élément spécifique au processus d'un nouveau projet d'équipe.

  • id : spécifie un nom qui identifie la tâche. Si une autre tâche dépend de cette tâche, elle référence cet ID. Vous devez assigner une valeur unique à l'ID dans le fichier de plug-in.

  • name : décrit ce que fait la tâche.

  • plugin : identifie le plug-in qui doit exécuter cette tâche.

  • completionMessage : spécifie le message à afficher pendant la création du projet d'équipe pour indiquer que la tâche s'est terminée correctement. La longueur maximale est de 256 caractères.

  • completionDescription : spécifie le message à afficher pendant la création du projet d'équipe pour indiquer que la tâche est en cours de traitement. La longueur minimale est de 1 caractère.

tasks

 
<tasks>
    <task>. . . </task>
</tasks>

Élément enfant obligatoire de taskXml.

Contient une collection d'éléments task qui spécifient chacun le travail à effectuer pour configurer un aspect spécifique au processus d'un nouveau projet d'équipe.

taskXml

 
<taskXml> . . . </taskXml>

Élément racine obligatoire pour un fichier de plug-in.

Décrit le travail nécessaire pour effectuer cette tâche. Le code XML à l'intérieur de ce bloc d'élément varie et est spécifique à chaque plug-in.

Notes

Le processeur XML ne tente pas de valider le contenu de l'élément.

Retour au début

Index des éléments taskXML par fonction

Pour plus d'informations sur les caractéristiques des éléments de balisage XML que vous pouvez spécifier pour chaque plug-in, consultez une des rubriques suivantes :

Retour au début

Exemple : définition de types d'éléments de travail

L'exemple suivant montre une tâche qui crée les six types d'éléments de travail en référençant les fichiers de définition pour chaque type.

<task
   id="WITs"
   name="WorkItemType definitions"
   plugin="Microsoft.ProjectCreationWizard.WorkItemTracking"
   completionMessage="WorkItemTypes created"         
   completionDescription = "Processing work item types used by work item tracking">
   <taskXml>
   <WORKITEMTYPES>
        <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\Bug.xml" />
        <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\SharedStep.xml" />
        <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\Task.xml" />
        <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\TestCase.xml" />
        <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\UserStory.xml" />
        <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\Issue.xml" />
   </WORKITEMTYPES>
   </taskXml>
</task>

Retour au début

Voir aussi

Concepts

Définir les dépendances pour les groupes de tâches et les tâches dans les fichiers de plug-in

Vue d'ensemble des fichiers de modèle de processus