次の方法で共有


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

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>

ページのトップへ

参照

概念

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

プロセス テンプレート ファイルの操作