カスタムビルドプロセスのアクティビティを使用と開発を行う

[アーティクル]
06/10/2015

カスタムビルドプロセステンプレートの作成後は、Windows Workflow 命令および組み込みの Team Foundation ビルド (TFBuild) アクティビティを使用して、独自のビジネスロジックを実装できます。これらのツールでは不十分な場合は、サードパーティのアクティビティを使用するか、必要に応じて CodeActivity に独自の .NET Framework コードを実装できます。

ヒント

カスタムビルドプロセス機能を Windows のバッチファイルまたは PowerShell スクリプトでコーディングできる場合は、スクリプトをアップロードし、ビルドプロセスの一部として実行できます。この方法は、カスタムビルドプロセスを作成するよりも迅速かつ簡単に実行できる可能性があります。「ビルドプロセスでスクリプトを実行する」を参照してください。

カスタムビルドプロセスアクティビティを作成する
ビルドプロセステンプレートを編集する
カスタムビルドプロセスをアップロードする
- TFVC チームプロジェクトでカスタムビルドプロセスをアップロードし、有効にする
- Git チームプロジェクトでカスタムビルドプロセスをアップロードし、有効にする
カスタムビルドプロセスを有効にする
ビルドを実行する
Q & A

カスタムビルドプロセスアクティビティを作成する

重要

開始する前に、テンプレートのコピーを取得し、コードプロジェクトに配置します。まだこの作業を行っていない場合は、こちらの操作手順に従ってください。

ビルドプロセステンプレートと同じソリューション内で、ビルドプロセスアクティビティを開発する必要があります。このようにすると、プロセステンプレート内のいずれかのアクティビティを使用する必要がある場合に、このアクティビティをワークフローデザイナーのツールボックスで利用できます。ただし、アクティビティのソースコードは、ビルドプロセステンプレートを含むプロジェクトとは別のコードプロジェクトで保持する必要があります。

ビルドプロセステンプレートのコードプロジェクトが含まれているソリューションに、C# または Visual Basic の新しいコードプロジェクトを追加します。
新しいコードプロジェクトに以下の参照を追加します。
- Microsoft.TeamFoundation.Build.Client.dll
- Microsoft.TeamFoundation.Build.Workflow.dll
どのようにすれば、これらの参照をコードプロジェクトに追加できますか。

コードプロジェクトを保存します。
新しいアクティビティをプロジェクトに追加します。

CodeActivity を実装します。たとえば、Hello.cs の場合は次のようになります。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Activities;
using Microsoft.TeamFoundation.Build.Workflow.Activities;
using Microsoft.TeamFoundation.Build.Client;
using Microsoft.TeamFoundation.Build.Workflow.Tracking;

namespace BuildProcessSource
{
    // enable the build process template to load the activity
    [BuildActivity(HostEnvironmentOption.All)]
    // keep the internal activity operations from appearing in the log
    [ActivityTracking(ActivityTrackingOption.ActivityOnly)]
    public sealed class Hello : CodeActivity
    {
        // Define an activity input argument of type string
        public InArgument<string> SayHelloTo { get; set; }

        // If your activity returns a value, derive from CodeActivity<TResult>
        // and return the value from the Execute method.
        protected override void Execute(CodeActivityContext context)
        {
            // Obtain the runtime value of the Text input argument
            string text = context.GetValue(this.SayHelloTo);

            // Add our default value if we did not get one
            if (text == null || text == "")
            {
                text = "World";
            }

            // Write the message to the log
            context.TrackBuildWarning("Hello " + text, BuildMessageImportance.High);
        }
    }
}

Activity1.xaml ファイルは必要ないので、削除してもかまいません。

Visual Studio でソリューションをビルドします (キーボード: Ctrl + Shift + B)。

完了すると、ソリューションは次のようになります。

カスタムビルドプロセスソリューションの例

ビルドプロセステンプレートを編集する

ソリューションで、アクティビティをビルドプロセステンプレートにドラッグして、テンプレートを編集します。アクティビティをテンプレートに追加してから、そのプロパティを設定します (キーボード: F4)。

ビルドプロセステンプレートをソリューションから編集

作業を終えたら、テンプレートを保存します。

カスタムビルドプロセスをアップロードする

カスタムビルドプロセステンプレートとアクティビティを使用するビルドを定義する前に、それらのビルドをアップロードして有効にする必要があります。

TFVC チームプロジェクトでカスタムビルドプロセスをアップロードし、有効にする
Git チームプロジェクトでカスタムビルドプロセスをアップロードし、有効にする

TFVC チームプロジェクトでカスタムビルドプロセスをアップロードする

TFVC アイコン TFVC チームプロジェクトで:

ソリューションをビルドしたことを確認します (キーボード: Ctrl + Shift + B)。
ビルドプロセスソースを格納する予定のチームプロジェクトに接続します (キーボード: Ctrl + 0、C)。
ソース管理エクスプローラーで、アクティビティコードプロジェクトを含むフォルダーに項目を追加します。
.dll ファイルが含まれているフォルダーを参照し、選択します。たとえば、C:\Users\YourName\Source\Workspaces\FabrikamTFVC\BuildProcessTemplates\BuildProcessSource\Source\bin\Debug です。
ファイルを追加するためにプロセスを終了します。
変更をチェックインします。

Git チームプロジェクトでカスタムビルドプロセスをアップロードする

Git アイコン Git チームプロジェクトで:

重要 :
- バイナリを格納すると (特に、大きなファイルの多数のリビジョンがある場合)、Git リポジトリのサイズが巨大になる可能性があります。アプリケーションをビルドするコードとは異なるリポジトリにカスタムビルドプロセスバイナリを格納することをお勧めします。この目的用に別のチームプロジェクトを作成したり、既存のチームプロジェクトに追加のリポジトリを作成したりすることができます。
- Git リポジトリのサブフォルダーにバイナリを格納する必要があります。ルートフォルダーのバイナリを使用しようとすると、"git 分岐が見つからない" というエラーメッセージによってブロックされる場合があります。
ソリューションをビルドしたことを確認します (キーボード: Ctrl + Shift + B)。
ビルドプロセスソースを格納する予定のチームプロジェクトに接続します (キーボード: Ctrl + 0、C)。
Git コマンドプロンプトを開きます。

Q: コマンドプロンプトを開けません。どうしたらよいですか。A: Git コマンドプロンプトを有効にする
Git コマンドプロンプトを使用して、.dll ファイルを追加します。次に例を示します。
```
cd c:\users\YourName\source\repos\BuildProcesses\BuildProcessSource\Source\bin\Debug

git add Source.dll -f
```
変更をコミットします。
コミットを同期またはプッシュします。

カスタムビルドプロセスを有効にする

カスタムビルドプロセスを実行するには、TFS にアップロードしたバイナリをビルドコントローラーに指定し、ビルド定義内のビルドプロセステンプレートを選択する必要があります。

[ビルド] ページ (キーボード: Ctrl + 0、B) で [アクション] を選択し、[ビルドコントローラーの管理] を選択します。
[ビルドコントローラーの管理] ダイアログボックスで、このビルドプロセスの実行に使用するコントローラーを強調表示し、[プロパティ] をクリックします。
カスタムアセンブリへのバージョンコントロールパスを指定します。

前の手順でビルドプロセスをアップロードしたフォルダーの先祖であるフォルダーを参照します。
- TFVC の例: $/FabrikamTFVC/BuildProcessTemplates/BuildProcessSource/Source/bin/Debug
- Git の例: BuildProcessSource/Source/Bin/Debug
  
  入力する値は、システムによって自動的に vstfs パスに変換されます。例: vstfs:///Git/VersionedItem/FabrikamGit/BuildProcesses/master/BuildProcessSource/Source/Bin/Debug
まだであれば、ビルド定義を作成または変更し、カスタムビルドプロセステンプレートを選択します。