カスタマイズ可能な Team Foundation のビルド プロパティ
更新 : 2007 年 11 月
MSBuild のプロパティはビルドを構成するためのキーと値のペアです。詳細については、「MSBuild プロパティ」を参照してください。
Microsoft.TeamFoundation.Build.targets ファイルには、MSBuild のターゲット、タスク、およびプロパティが、Team Foundation ビルド用にいくつか定義されています。これらのプロパティを TFSBuild.proj ファイルで変更すると、以下を行うことができます。
Team Foundation ビルドのタスクおよびターゲットに値を渡す。
特定のビルド アクションをオーバーライドする。
TFSBuild.proj ファイルの詳細については、「Team Foundation ビルドの構成ファイルについて」を参照してください。
目次
VC++ ビルドのカスタマイズ
タスクのカスタマイズに使用するプロパティ
オーバーライドできるプロパティ
次の表は、Team Foundation ビルドに定義されているプロパティの一覧です。TfsBuild.proj ファイルでオーバーライドして、ビルド処理をカスタマイズできます。詳細については、「方法 : SolutionToBuild 項目グループをカスタマイズする」を参照してください。
プロパティ |
説明 |
|---|---|
CustomPropertiesForClean |
このプロパティを設定すると、Team Foundation ビルドが Clean ターゲットを呼び出すときに、すべてのソリューションにカスタム値が渡されます。 |
CustomPropertiesForBuild |
このプロパティを設定すると、Team Foundation ビルドが既定のターゲット (通常は Build) を呼び出すときに、すべてのソリューションにカスタム値が渡されます。 |
SkipClean |
このプロパティを設定すると、CoreClean ターゲットがスキップされます。 |
IncrementalGet |
このプロパティを true に設定すると、インクリメント方式の取得が実行されます。このプロパティは、CleanCompilationOutputOnly を true に、SkipInitializeWorkspace を true に、ForceGet を false に設定するのに便利です。 |
IncrementalBuild |
このプロパティを true に設定すると、インクリメンタル ビルドが実行されます。このプロパティは、SkipClean を true に、SkipInitializeWorkspace を true に、ForceGet を false に設定するのに便利です。 |
CleanCompilationOutputOnly |
このプロパティを true に設定すると、CoreClean ターゲットの実行時に、ソース ディレクトリから中間アセンブリのみが削除されます。このプロパティを false に設定すると、CoreClean ターゲットの実行時に、ソース ディレクトリ全体が削除されます。 |
SkipGetChangesetsUpdateWorkItems |
このプロパティを true に設定すると、変更セットの関連付けと、成功したビルドの作業項目の更新がスキップされます。 |
SolutionRoot |
このプロパティを設定すると、ビルド コンピュータ上のソース フォルダのルートが指定されます。 |
BinariesRoot |
このプロパティを設定すると、ビルド コンピュータ上のバイナリ フォルダのルートが指定されます。 |
LabelComment |
このプロパティを設定すると、Label タスクによって使用されるコメントを定義できます。 |
LabelName |
このラベル名を設定すると、Label タスクによって使用される名前を定義できます。既定では、ラベル名は InitializeEndToEndIteration ターゲット内の $(BuildNumber) に設定されます。 |
OutDir |
このプロパティを設定すると、ビルド作業ディレクトリ内の出力ファイルの場所を定義できます。 |
UpdateAssociatedWorkItemsOnBuildBreak |
このプロパティを true に設定すると、失敗したビルドであっても、関連付けられている作業項目が更新されます。 |
StopOnFirstFailure |
このプロパティを true に設定すると、ビルドの実行中に最初のエラーが生じた時点で、消去、コンパイル、テストなどが停止されます。 |
SkipGet |
このプロパティを設定すると、CoreGet ターゲットがスキップされます。 |
SkipLabel |
このプロパティを設定すると、CoreLabel ターゲットがスキップされます。 |
SkipInitializeWorkspace |
このプロパティを設定すると、CoreInitializeWorkspace ターゲットがスキップされます。 |
SkipInvalidConfigurations |
このプロパティを false に設定すると、無効な構成が見つかったときに、警告ではなくエラーが生成されます。 |
SkipPostBuild |
関連する変更セットおよび作業項目の収集をスキップするには、このプロパティを設定します。 |
SkipDropBuild |
このプロパティを設定すると、CoreDropBuild ターゲットがスキップされます。 |
SkipWorkItemCreation |
このプロパティを設定すると、CoreCreateWorkItem ターゲットがスキップされます。 |
CustomizableOutDir |
Team Foundation ビルドでソリューションごとに OutDir が設定されないようにするには、このプロパティを true に設定します。CustomizablePublishDir を false に設定した場合は、TeamBuildPublishDir プロパティを使用して、Team Foundation ビルドによって PublishDir に割り当てられている値を取得できます。 |
CustomizablePublishDir |
Team Foundation ビルドでソリューションごとに PublishDir ディレクトリが設定されないようにするには、このプロパティを true に設定します。CustomizablePublishDir を false に設定した場合は、TeamBuildPublishDir プロパティを使用して、Team Foundation ビルドによって PublishDir に割り当てられている値を取得できます。 |
VC++ ビルドのカスタマイズ
Team Foundation ビルドは、Visual C++ プロジェクトのビルドのカスタマイズもサポートしています。次のプロパティを使用すると、Visual C++ プロジェクトをビルドするために MSBuild で使用される VCBuild タスクに対応するプロパティを設定できます。詳細については、「VCBuild タスク」を参照してください。
チーム ビルド プロパティ |
VCBuild タスク プロパティ |
説明 |
|---|---|---|
VCBuildAdditionalLibPaths |
AdditionalLibPaths |
LIB 環境変数パスが検索される前に、ライブラリを検索するための追加のパスを指定します (LINK.exe の LIBPATH オプションに該当します)。 |
VCBuildAdditionalOptions |
AdditionalOptions |
専用のタスク パラメータがない追加のコマンド ライン オプションを指定します。 |
VCBuildToolPath |
ToolPath |
VCBuild タスクが、基になる実行可能ファイル (VCBuild.exe) を読み込む場所を指定します。 |
VCBuildUseEnvironment |
UseEnvironment |
このプロパティを true に設定すると、PATH、INCLUDE、LIBS、および LIBPATH の環境変数が使用されます。それ以外の場合は false に設定します。VCBuild.exe の場合、このプロパティは /useenv オプションに対応します。詳細については、「/useenv」を参照してください。 |
AdditionalVCOverrides |
なし |
このプロパティを使用して、Team Foundation ビルドによって生成され、VCBuild タスクの Override プロパティで指定される VCBuild タスク シート ファイルに追加のオプションを指定します。 |
タスクのカスタマイズに使用するプロパティ
Microsoft.TeamFoundation.Build.targets ファイルの既定の各 Team Foundation ビルド タスクには、タスクのカスタマイズに使用できるプロパティも含まれています。Team Foundation ビルド タスクの詳細については、「Team Foundation ビルドのタスク」を参照してください。たとえば、CreateNewWorkItem タスクは次のように定義されています。
<!-- Create WorkItem for build failure -->
<CreateNewWorkItem
TeamFoundationServerUrl="$(TeamFoundationServerUrl)"
BuildUri="$(BuildUri)"
BuildNumber="$(BuildNumber)"
Description="$(WorkItemDescription)"
TeamProject="$(TeamProject)"
Title="$(WorkItemTitle)"
WorkItemFieldValues="$(WorkItemFieldValues)"
WorkItemType="$(WorkItemType)"
ContinueOnError="true" />
ビルドのエラー時に作成される作業項目をカスタマイズするには、以下のように TFSBuild.proj ファイルで WorkItemFieldValues を設定します。
.gif "メモ") メモ : |
|---|
次の例では、Areapath プロパティと IterationPath プロパティも設定済みであることを前提としています。 |
<WorkItemFieldValues>Area Path=$(AreaPath);Iteration Path=$(IterationPath);Severity=1;Priority=0;Symptom=build break;Steps To Reproduce=Start the build using Team Build;Source=Development;How Found=Build Break;Assigned To=Active</WorkItemFieldValues>