定义用于处理插件的任务

  • 项目

可使用 tasks 元素及其子元素定义要上载的项目或要为插件创建的特定元素。 任务指定必须发生的工作，以配置特定于新团队项目中相应过程的内容。 给定数的任务您定义上载工作项类型，工作项的团队项目查询，文档，并将报告。 您可以定义的其他任务将配置 Visual Studio Application Lifecycle Management 的其他区域，如 Team Foundation Build、Visual Studio 实验室管理工具版、测试管理器和 Team Foundation 版本控制。

主题内容

  • 任务语法结构

  • 任务元素参考

  • taskXML 元素按功能的索引

  • 示例：定义工作项的类型

任务语法结构

可在插件文件中指定多个任务，这些任务可能互相依赖。 为每个插件定义的任务必须符合 Tasks.xsd 文件中定义的 tasks 架构定义，且必须使用 tasks 容器元素在其自己的文件中指定。

以下语法显示了 tasks 元素及其子元素的高层次结构。

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

返回页首

任务元素参考

下表介绍了每个可为插件定义任务的元素。

元素

语法

说明

dependencies

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

task 的可选子元素。

指定某个组所依赖的其他组。

dependency

 
<dependency taskId="taskId" />

dependencies 的可选子元素。

指定此任务所依赖的其他任务的 ID。 其他任务必须完成，此任务才可以开始。

ProcessTemplate

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

其中，每个特性定义如下：

  • Type：正在上载的文件的类型。 以下是有效值：Default 和 Upgrade 适用于生成模板文件；Custom 适用于实验室模板文件。

  • Filename：要上载的文件的本地目录路径和名称。

  • Description：描述要上载的文件的短文本字符串。

  • ServerPath：在其中运行应上载文件的 Team Foundation Server 的服务器的路径。 唯一有效的上载位置是 $/$$PROJECTNAME$$/BuildProcessTemplates。

生成和实验室插件的 taskXml 元素的可选子元素。

指定要上载的文件的名称、位置和目标以支持团队项目的生成过程。

task

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

tasks 的必需子元素。

指定为了配置特定于新团队项目中的过程的某些内容而必须完成的工作。

  • id：指定标识任务的名称。 如果其他任务依赖于此任务，则该任务将引用此 ID。 您必须为插件文件中的 ID 分配一个唯一值。

  • name：描述任务执行的操作。

  • plugin：标识必须运行此任务的插件。

  • completionMessage：指定在创建团队项目期间显示的指示任务成功完成的消息。 最大长度为 256 个字符。

  • completionDescription：指定在创建团队项目期间显示的指示任务正在进行的消息。 最小长度为 1 个字符。

tasks

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

taskXml 的必需子元素。

包含一组 task 元素，其中每个元素都指定特定于新团队项目过程进行配置所必须执行的工作。

taskXml

 
<taskXml> . . . </taskXml>

插件文件必需的根元素。

描述了完成此任务所需要的工作。 此元素块中的 XML 随每个插件不同而不同，并特定于每个插件。

备注

XML 处理器不会尝试验证元素中的内容。

返回页首

taskXML 元素按功能的索引

有关可为每个插件指定的 XML 标记元素的详细信息的更多信息，请参见以下主题之一：

返回页首

示例：定义工作项的类型

下面的示例演示了一个通过引用每种类型的定义文件创建六种类型的工作项：

<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>

返回页首

请参见

概念

在插件文件中定义任务组和任务的依赖项

过程模板文件概述