チュートリアル : BuildStep タスクを使用したビルド ステップの追加

  • [アーティクル]

更新 : 2007 年 11 月

BuildStep タスクは、Team Foundation Server 向けに作成された MSBuild タスクです。BuildStep タスクをビルドに追加するには、ソリューションのビルド定義の TFSBuild.proj ファイル内にある Target 要素に 1 つ以上の BuildStep 要素を追加します。

必要条件

ビルド定義に BuildStep タスクを追加するのに必要な条件は、次のとおりです。

必要なアクセス許可

このトピックの手順を実行するには、[チェックイン] または [チェックアウト] のアクセス許可が [許可] に設定されている必要があります。詳細については、「Team Foundation Server のアクセス許可」を参照してください。

BuildStep タスクを使用してビルド ステップを追加するには、次の手順を実行します。

  • プロジェクト ファイルにタスクを追加する

  • プロジェクト ファイルに情報提供を目的としたビルド ステップを追加する

プロジェクト ファイルにタスクを追加する

BuildStep タスクを使用して、ビルド ステップを追加および更新できます。この手順では、次のように TFSBuild.proj ファイルを変更する方法について説明します。

  1. ビルド ステップを追加します。

  2. タスクを実行します。

  3. タスクが正常に終了した場合は成功、タスクが正常に終了しなかった場合は失敗というステータスでビルド ステップを更新します。

この例では、ビルド ステップ タスクは、新しい場所にソース ファイルをコピーします。

TFSBuild.proj ファイルにビルド ステップを追加および更新するには

  1. Visual Studio を起動します。

  2. 変更する TFSBuild.proj ファイルを Team Foundation バージョン管理からチェックアウトし、Visual Studio XML エディタで開きます。

  3. <ItemGroup> 要素に次の XML を追加します。既存の <ItemGroup> 要素にこの XML を追加することも、新しい <ItemGroup> 要素を追加することもできます。

    Cc668755.alert_note(ja-jp,VS.90).gifメモ :

    この手順のコードは、コピーされたソース ファイルが配置されたフォルダを特定します。その他の MSBuild タスクでは、XML に他にも追加することが必要なものがある場合があります。MSBuild タスクの要件の詳細については、「MSBuild タスク リファレンス」を参照してください。

    		 
    <ItemGroup>
    <SourceFileFolder Include="C:\WorkingFolder\TeamBuildTypes\**\*.cs" />
</ItemGroup>

  4. TFSBuild.proj ファイルの末尾の </Project> 要素の直前に、次の XML を追加します。

    </ItemGroup>
    <Target Name="BeforeCompile">        <BuildStep            TeamFoundationServerUrl="$(TeamFoundationServerUrl)"            BuildUri="$(BuildUri)"            Message="Working...">            <Output TaskParameter="Id" PropertyName="StepId" />        </BuildStep>        <!-- Perform a task... -->        <Copy SourceFiles="@(SourceFileFolder)"            DestinationFolder="C:\NewSourceFileFolder"        />        <BuildStep            TeamFoundationServerUrl="$(TeamFoundationServerUrl)"            BuildUri="$(BuildUri)"            Id="$(StepId)"            Status="Succeeded" />        <OnError ExecuteTargets="MarkBuildStepAsFailed" />    </Target>    <Target Name="MarkBuildStepAsFailed">        <BuildStep            TeamFoundationServerUrl="$(TeamFoundationServerUrl)"            BuildUri="$(BuildUri)"            Id="$(StepId)"            Status="Failed" />    </Target>
</Project>
    Cc668755.alert_note(ja-jp,VS.90).gifメモ :

    Team Foundation ビルド ターゲットと、カスタマイズ可能なターゲットの一覧の詳細については、「カスタマイズ可能な Team Foundation のビルド ターゲット」を参照してください。

  5. 変更を保存し、TFSBuild.proj を閉じます。

  6. TFSBuild.proj ファイルをバージョン管理にチェックインします。

  7. ビルド定義を実行します。

    詳細については、「方法 : ビルド定義をキューに配置する/ビルド定義を開始する」を参照してください。

    ビルド エクスプローラでビルド ステップ メッセージを表示することも、ビルド ログで完了したビルド ステップの作成処理および更新処理を確認することもできます。また、コピーされたファイルは、指定したディレクトリで見つかります。詳細については、「方法 : ビルドの進行状況を監視する」を参照してください。

プロジェクト ファイルに情報提供を目的としたビルド ステップを追加する

タスクを実行する必要がなくても、情報提供を目的としたビルド ステップを追加する場合は、Id Output プロパティを使用せずに、直接ステータスを設定します。この手順では、ビルド エクスプローラでビルドを開く際に表示されるメッセージだけをビルド処理に追加します。

情報提供を目的としたビルド ステップを TFSBuild.proj ファイルに追加するには

  1. Visual Studio を起動します。

  2. 変更する TFSBuild.proj ファイルを Team Foundation バージョン管理からチェックアウトし、Visual Studio XML エディタで開きます。

  3. TFSBuild.proj ファイルの末尾の </Project> タグの直前に、次の XML を追加します。

    </ItemGroup>
    <Target Name="AfterCompile">        <BuildStep            TeamFoundationServerUrl="$(TeamFoundationServerUrl)"            BuildUri="$(BuildUri)"            Message="Compile step complete."            Status="Succeeded" />    </Target>
</Project>
    Cc668755.alert_note(ja-jp,VS.90).gifメモ :

    Team Foundation ビルド ターゲットの詳細と、カスタマイズ可能なターゲットの一覧については、「カスタマイズ可能な Team Foundation のビルド ターゲット」を参照してください。

  4. 変更を保存し、TFSBuild.proj を閉じます。

  5. TFSBuild.proj ファイルをバージョン管理にチェックインします。

  6. ビルド定義を実行します。

    詳細については、「方法 : ビルド定義をキューに配置する/ビルド定義を開始する」を参照してください。

    メッセージは、ビルド エクスプローラおよびビルド ログで確認できます。詳細については、「方法 : ビルドの進行状況を監視する」を参照してください。

参照

参照

BuildStep タスク

その他の技術情報

MSBuild タスク リファレンス

MSBuild プロジェクト ファイル スキーマ リファレンス