プラグインを処理するタスクの定義

  • [アーティクル]

tasks 要素とその子要素を使用して、アップロードされる成果物またはプラグインに対して作成される特定要素を定義します。 タスクは、新しいチーム プロジェクトでプロセスに固有のものを構成するために実行する必要がある作業を指定します。 定義する複数のタスクによって、チーム プロジェクトの作業項目の種類、作業項目クエリ、ドキュメント、およびレポートがアップロードされます。 他には、Team Foundation ビルド、Visual Studio Lab Management、Test Manager、Team Foundation バージョン管理などの、Visual Studio アプリケーション ライフサイクル管理 の他の領域を構成するタスクも定義できます。

このトピックの内容

  • タスクの構文構造

  • タスク要素リファレンス

  • 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 マークアップ要素の詳細については、次のいずれかのトピックを参照してください。

ページのトップへ

例: 作業項目の種類の定義

次の例では、種類ごとに定義ファイルを参照することによって 6 種類の作業項目を作成するタスクを示します。

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

ページのトップへ

参照

概念

プラグイン ファイルのタスク グループとタスクの依存関係の定義

プロセス テンプレート ファイルの概要