チュートリアル : チェックイン ポリシーとチェックイン メモのカスタマイズ
Team Foundation では、次のようなカスタムのチェックインを作成できます。
チェックイン メモのテンプレートと要件の作成
チェックインに関連する情報を収集し、チェックイン処理中に情報を指定するようユーザーに要求する、独自のフィールドを定義できます。この情報は、チェックイン コメントと同様に、他の変更セットの詳細と共に永続化されます。この情報を電子メール通知に含めて、他のチーム メンバーに配信することができます。
チェックイン ポリシーの定義
カスタム チェックイン規則を定義すると、ソース管理サーバーにコミットできる変更の種類に関して制限を課すことができます。プロジェクト管理者は、ソースの変更内容がサーバーにコミットされる前にそれを検証する規則を定義できます。Team Foundation に付属のチェックイン ポリシーは、作業項目が変更に関連付けられていること、単体テストが成功したこと、およびソース コードに対してスタティック分析が正しく実行されたことを検証します。プラグイン モデルを使用してこれらのポリシーを拡張すると、新しいポリシー プラグインを作成して、さまざまな種類の要件を簡単に適用することができます。チーム プロジェクトに適用されるチェックイン ポリシーは、そのチーム プロジェクトが使用している MSF プロセスによって決まります。
このチュートリアルでは、チェックイン メモの追加方法と、チェックインのたびに作業項目を関連付けるように要求するチェックイン ポリシーの定義方法について説明します。
必要なアクセス許可
このチュートリアルを完了するためには、[チェック アウト] および [サーバーレベル情報の編集] のアクセス許可が [許可] に設定されている必要があります。詳細については、「Team Foundation Server のアクセス許可」を参照してください。
チェックイン メモの作成
Team Foundation では、チームのチェックイン メモ用の独自のフィールドを定義し、チェックイン処理でのユーザー要件をサーバーのルート フォルダー レベル (たとえば、$/folder1) に設定できます。各フォルダーは、チーム プロジェクトに対応します。この設定は、フォルダーの下に格納されるすべてのソースに適用されます。カスタム チェックイン メモまたは要件が定義されているサーバー フォルダーに対してユーザーがリビジョンのチェックインを行うと、[チェックイン] ダイアログ ボックスまたは [チェックイン] ウィンドウでメモを入力するよう求められます。チェックイン メモは省略可能にすることも必須にすることもできますが、必須のメモに対して実行される検証は、指定されたテキストの長さが 0 より大きいかどうかの検証のみです。
チェックイン メモを追加および構成するには
チーム エクスプローラーでチーム プロジェクトを右クリックし、[チーム プロジェクトの設定] をクリックして、[ソース管理] をクリックします。
[ソース管理の設定] ダイアログ ボックスが表示されます。
[チェックイン メモ] タブをクリックし、[追加] をクリックします。[チェックイン メモの追加] ダイアログ ボックスが表示されます。
[名前] ボックスに、ドキュメント チームの新しいチェックイン メモに使用する名前 (例: "ドキュメントの影響") を入力します。
必要に応じて、[チェックインで必要] を選択して [追加] をクリックします。これにより、チェックイン処理時にこのチェックイン メモにテキストを追加することが必須になります。
必要に応じて、チェックイン メモの順序を変更します。移動するチェックイン ノートを選択し、矢印ボタンで配置順序を変更してください。
チェックイン メモの設定が完了したら、[OK] をクリックします。
これで、以降のチェックインで新しいチェックイン メモが表示されるようになります。
コマンド プロンプトから新しいチェックイン メモを表示するには、適切に構成されたルート レベルのフォルダーからファイルをチェックアウトして編集し、リビジョンをチェックインします。[チェックイン] ダイアログ ボックスの [チェックイン メモ] チャネルを選択すると、カスタム フィールドが表示されます。
定義済みのチェックイン ポリシーの構成
さらにチェックインをカスタマイズするには、変更内容が組織の標準に従っているかどうかを評価する、定義済みのチェックイン ポリシーを構成できます。
定義済みのチェックイン ポリシーを構成するには
チーム エクスプローラーでチーム プロジェクトを右クリックし、[チーム プロジェクトの設定] をクリックして、[ソース管理] をクリックします。
[ソース管理の設定] ダイアログ ボックスが表示されます。
[チェックイン ポリシー] タブをクリックし、[追加] をクリックします。
[チェックイン ポリシーの追加] ダイアログ ボックスが表示されます。
[チェックイン ポリシー] ボックスの一覧で、目的のポリシーの種類 ([ビルド]、[コード分析]、[テスト ポリシー]、または [作業項目]) をクリックし、[OK] をクリックします。
[ビルド] を選択した場合は、ポリシーが一覧に追加されます。このポリシーは、前のビルドが成功していなければ新しい変更をチェックインできないと規定しています。
[コード分析] を選択した場合、[コード分析ポリシー エディター] ダイアログ ボックスが表示されます。実行するコード分析の種類に対応するチェック ボックスをオンにします。オプションには、[現在のソリューションの一部であるファイルのみのチェックインを強制]、[C/C++ コード分析 (/analyze) を強制]、および [マネージ コードのコード分析を強制] があります。[マネージ コードのコード分析を強制] を選択した場合は、[マネージ コード分析の規則設定] ウィンドウで必要な規則設定を選択します。[OK] をクリックします。コード分析ツールの使用方法の詳細については、「コード分析ツールを使用するためのガイドライン」を参照してください。
[テスト ポリシー] をクリックした場合は、[テスト ポリシー] ダイアログ ボックスが表示されます。[参照] をクリックしてメタデータ ファイルを指定し、使用するテストを選択して、[OK] をクリックします。
[作業項目] を選択した場合、作業項目をチェックインと関連付ける必要があるというポリシーが一覧に追加されます。
チェックイン ポリシーの設定が完了したら、[OK] をクリックします。これで、以降のチェックインで新しいチェックイン ポリシーが表示されるようになります。
チェックイン ポリシーを表示するには、先ほど定義したフォルダーからファイルをチェックアウトして編集し、[チェックイン] ダイアログ ボックス、または Visual Studio の [保留中の変更] ウィンドウを使用してリビジョンをチェックインします。または、コマンド プロンプトで「tf checkin」と入力します。詳細については、「Checkin コマンド」を参照してください。
ダイアログ ボックスまたはツール ウィンドウで [ポリシーの警告] チャネルを選択すると、定義されているチェックイン ポリシーに変更が準じているかどうかを示すメッセージが表示されます。[作業項目] チャネルの作業項目を選択していない場合、ポリシーに準じていないことを示すメッセージが表示されます。ポリシーに準拠するには、[作業項目] チャネルに切り替えて、変更に関連付ける作業項目を選択します。または、ポリシーに準拠していない状態のまま、チェックインを続行することもできます。この場合、チェックイン ポリシーを無視する理由を説明するように求められます。