Ant 属性参照

このトピックでは、Jazz™ Team Build の Ant タスク属性について説明します。

下の表で、Jazz Team Build Ant タスクの属性について説明します。

属性 説明

activityId

ビルド・アクティビティーの固有 ID。completeBuildActivity に渡された activityId は、 startBuildActivity タスクによって設定されるプロパティーに保持されます。activityId 属性値は、${} プロパティー値の置換構文 を使用して指定します。

activityIdProperty

新規に開始されたアクティビティーの固有の ID を保管します。 呼び出し元が completeBuildActivity タスクを使用してこのアクティビティーを明示的に完了する場合、またはこのアクティビティーが子アクティビティーの親として使用される場合にのみ必要です。

autoComplete

startTeamBuild タスクでは、ビルドを自動的に完了させるかどうかを指定します。デフォルトは true です。この属性が true の場合、Ant を起動するときに、パラメーター -listener com.ibm.team.build.ant.listener.TeamBuildListener を使用する必要があります。

startBuildActivity タスクでは、親アクティビティーが完了したとき、次のピア・アクティビティーが開始したとき、ビルドが完了したときのいずれかの状況でアクティビティーを自動的に完了するかどうかを指定します。デフォルトは false です。

buildDefinitionId

getNextTeamBuildRequest タスクでは、保留中の要求をチェックするためのビルド定義 ID を指定します。 ビルド定義 ID が指定されたビルド・エンジンでサポートされていない場合、要求は検索されません。

requestTeamBuild タスクでは、使用するビルド定義の識別子。

startTeamBuild タスクでは、開始するビルドのビルド定義。 requestUUID が指定されていない場合は必須です。

buildDefinitionIdProperty

指定されたエンジンの次のビルド要求のビルド定義 ID を保管します。指定されたエンジンの要求が取得された場合のみ定義されます。buildDefinitionId が指定されている場合は適用されません。

buildLabel

Jazz ビルド・エンジン によって生成されたビルド・ラベル。 例えば、20080215-1234 のようになります。

buildLabelPrefix

ビルド・ラベルの接頭部を指定します。例えば、integration の場合、I とします。このプロパティーをビルド定義またはビルド・エンジンに定義すると、その値が Jazz ビルド・エンジン が生成したラベルの前に付加されます。 例えば、I20080215-1234 のようになります。

buildResultUUID

更新するビルド結果の UUID。 プロパティーは Jazz ビルド・エンジンを使用するときに組み込まれるため、通常この属性の値は、${buildResultUUID} です。

completeBuild タスクでは、完了するビルド結果の UUID。

teamAccept タスクでは、スナップショット情報を使用して更新するビルド結果。 スナップショットは、後でビルド・ワークスペースの再作成に使用することができます。

teamFetch タスクでは、このビルド結果に、ビルド・ワークスペースの情報が反映されます。これにより、ビルド結果を後からビルド・ワークスペースで再作成できるようになります。この属性は、ビルドあたりのこのタスクの呼び出しを最大 1 回に設定する必要があります。ビルド結果には複数のワークスペースを関連付けることができません。 ビルド結果に、すでにワークスペースが関連付けられている場合、このタスクは例外をスローします。

waitForTeamBuild では、待機中のビルド結果の UUID。通常、これは、resultUUIDProperty 属性によって指定されたプロパティーでビルド結果の UUID を返す {@link StartBuildTask} を使用してビルドが開始された場合に指定されます。

buildNotNecessary

ビルドが必要でない場合は、true に設定します。 例えば、前のビルド以来ソースの変更がない場合、ビルドの必要がないことがあります。この属性は、ビルドのライフ・サイクル全体をコントロールする Ant スクリプトでのみ使用します。

buildStateProperty

タスクが待機を終了したときのビルドの状態を記述するためのプロパティー。これは、ビルドが指定された待機状態の 1 つに入る場合のみ設定されます。

buildStatusProperty

このプロパティーではビルドの状況が割り当てられます。値は、「OK」、「情報」、「警告」、または「エラー」のいずれかになります。

changeSetFile

直列化された変更セットの保管に使用されるファイル。

changesAcceptedProperty

受け入れ済みの変更セットの数を保管します。少なくとも 1 つの変更セットが受け入れられた場合のみ、プロパティーが定義および設定されます。

componentMap

パッケージ名のコンポーネントへのマッピング情報を含むファイルのパス。

パッケージ名のコンポーネントへのマッピング情報を含むファイルのパス。パッケージ名は、テスト・スイート・クラスのパッケージと一致する必要があります。

componentName

このコントリビューションに関連付ける特定のコンポーネント。

contentType

成果物のタイプ。指定されない場合は、application/unknown に設定されます。

filePublisher タスクでは、成果物のタイプ。 指定されない場合、デフォルトは application/unknown です。

logPublisher タスクでは、成果物のタイプ。指定されない場合、デフォルトは text/plain です。

contributionTypeId

このコントリビューションの拡張コントリビューション・タイプ ID。

characterEncoding

成果物ファイルで使用される文字エンコード。これは IANA 準拠名でなければなりません。現行プラットフォームのデフォルト・エンコードがデフォルトになります。詳しくは、IANA List of Character Set Names を参照してください。

deletePropertiesFile

プロパティー・ファイルのパス。 このプロパティー・ファイルは、ビルドの実行時に省略するプロパティーを指定します。このプロパティーはビルド定義内に存在すると想定されます。 パスには、ビルド・ファイルのベース・ディレクトリーからの相対パスを指定するか、絶対パスを指定することができます。

deleteAllowed

ビルド結果の削除を許可するかどうかを設定します。

destination

取り出されたファイルが保管されるローカル・ディレクトリー。

engineId

getNextTeamBuildRequest タスクでは、次のビルド要求を検索するビルド・エンジンの識別子。

startTeamBuild タスクでは、ビルドを実行するビルド・エンジンの識別子。requestUUID が指定さていない場合は必須です。

failOnError

true (デフォルト) の場合は、エラーが発生したときにタスクは失敗します。false の場合、いくつかのエラーは無視されてタスクが完了します。

filePath

入力ファイルを必要とするタスクで、ファイルのパスを指定します。絶対パスか、ビルド・ファイルのベース・ディレクトリーからの相対パスを指定することができます。

XML ログへのパス、または XML ログを含むディレクトリーへのパス。パスには、ビルド・ファイルのベース・ディレクトリーからの相対パスを指定するか、絶対パスを指定することができます。

jdtCompileLogPublisher タスクでは、JDT コンパイラー・ログ・ファイルまたは公開するファイルのディレクトリーへのパス。

filePublisher タスクでは、公開するファイルまたは公開するファイルのディレクトリーへのパス。

workItemPublisher タスクでは、パスを teamAccept タスクから出力される変更セット・ファイルまたはワークアイテム・ファイルに設定します。ワークアイテム・ファイルには、行あたり 1 つのワークアイテム ID が含まれている必要があります。 パスには、ビルド・ファイルのベース・ディレクトリーからの相対パスを指定するか、絶対パスを指定することができます。

mstestLogPublisher では、 TRX XML ログへのパス、または TRX XML ログを含むディレクトリーへのパス。パスには、ビルド・ファイルのベース・ディレクトリーからの相対パスを指定するか、絶対パスを指定することができます。

inputFileType

workItemPublisher タスクでは、このフラグによって、filePath 属性が変更セット・ファイルであるかワークアイテム・ファイルであるかを示します。有効な値は CHANGESET および WORKITEM です。この属性が指定されていない場合、タスクは filePath 属性が変更セット・ファイルを指すと想定します。

interval

ビルドが、必要な状態になっているかどうかを判別するチェック間隔の時間。値は、秒で表され、ゼロより大きく、かつタイムアウト値以下である必要があります。デフォルトは 30 秒毎のチェックです。

label

ビルドに使用するラベル。

startBuildActivity では、ビルド・アクティビティーを記述するラベルです。指定しない場合、activityID の値がラベルとして使用されます。

LocalFilePath

公開されるリンクのファイル・サイズの計算に使用されるローカル・ファイルへのパス。

mayFailPattern

テスト・スイート・クラス名のサブストリング。 パターンを含むテスト・スイート・クラス名は、失敗してもビルド全体の失敗を引き起こしません。パターンは正規表現ではなくシンプル・ストリングです。指定しない場合、テスト・スイートの失敗がビルドの失敗の原因になります。

overridePropertiesFile

プロパティー・ファイルのパス。 このプロパティー・ファイルは、新規プロパティーを追加するか、ビルド定義内の既存のプロパティーをオーバーライドできます。 パスには、ビルド・ファイルのベース・ディレクトリーからの相対パスを指定するか、絶対パスを指定することができます。

outputPropertiesFile

sourceDirectory の下の各ディレクトリーのプロパティーを含めるために作成される出力ファイルを指定します。このプロパティー・ファイルには、フォルダーのパスと、sourceDirectory 内の各フォルダーの変更時間を示すタイム・スタンプが含まれます。各プロパティーの値は、GMT による最終変更日時です。 ファイルは、Java スタイル・プロパティー・ファイルとしてフォーマット設定されます。 以下に例を示します。

  • com.ibm.team.scm.admin.service=200803060309
  • com.ibm.team.scm.client=200803060309
  • com.ibm.team.scm.feature.server=200803060309

parentActivityID

親として使用する既存のアクティビティーの識別子。この識別子のアクティビティーは存在していなければならず、かつ、完了していてはいけません。

password

ユーザー ID のパスワード。指定しない限り、デフォルトのゼロ長ストリングです。

passwordFile

接続に使用するパスワード・ファイル。 -createPasswordFile 引数で Jazz ビルド・エンジンを呼び出すことで、適切なパスワード・ファイルを作成することができます。パスワード・ファイルは 1 つだけ指定できます。

pdeBuild

true の場合、パブリッシャーはログ・ディレクトリー構造が PDE ビルドにより生成されていると解釈します。プラグイン・ディレクトリーは、所定の filePath の下の階層で表示されます。パブリッシャー・グループはプラグインごとにパッケージ化されます。

rawOutputPropertiesFile

プロパティー・ファイルのパス。 パスには、ビルド・ファイルのベース・ディレクトリーからの相対パスを指定するか、絶対パスを指定することができます。このプロパティー・ファイルには、内部フォルダーおよび sourceDirectory 内の各フォルダーの最新のベースラインを表すベースライン ID が含まれます。

requestUUID

ビルドを開始するときに使用する既存のビルド要求を指定します。これを指定した場合、buildDefinitionID および engineID は指定できません。

waitForTeamBuild では、待機中のビルド要求の UUID。通常、これは、requestUUIDProperty 属性によって指定されたプロパティーでビルド要求の UUID を返す {@link RequestBuildTask} を使用してビルドが要求された場合に指定されます。

requestUUIDFile

指定されたビルド・エンジンの次のビルド要求の UUID を保管するファイルのパス。パスは、ビルド・ファイルのベース・ディレクトリーに対する相対パス、または絶対パスにすることができます。ファイルは java.util.Properties フォーマットとしてフォーマット設定され、requestUUIDProperty によって指定された名前のプロパティーを含みます。

requestUUIDProperty

検索されたビルド要求の UUID を保管します。要求が検出された場合のみ設定されます。

repositoryAddress

使用するチーム・リポジトリーのアドレス。プロパティーは Jazz ビルド・エンジンを使用するときに組み込まれるため、通常この属性の値は ${repositoryAddress} です。

resultUUIDFile

ビルド結果を保管するために使用するファイル。 パスはビルド・ファイルのベース・ディレクトリーへの相対パス、または絶対パスにすることができます。ファイルは java.util.Properties フォーマットとしてフォーマット設定され、resultUUIDProperty 属性によって指定された名前のプロパティーを含みます。

resultUUIDProperty

ビルド結果の UUID を保管するプロパティー。

snapshotName

ワークスペースで作成されるスナップショットの名前。

snapshotUUIDProperty

作成されるスナップショットの UUID にアクセスするためのプロパティー名を指定します。

sourceDirectory

pluginOrganizer タスクでは、使用されるソース・ディレクトリー。これは、プラグインおよびフィーチャー・ディレクトリーを含むことが想定されます。

teamLastModified タスクでは、ローカル・ファイル・システム内のディレクトリー・ロケーション。 sourceDirectory 属性の値は、Jazz リポジトリー のワークスペースのルートでなければなりません。 例えば、teamFetch タスクが c:¥fetched に取り出す場合、teamLastModified の sourceDirectory は c:¥fetched になります。 このタスクには、SCM ツールのコマンド行ユーティリティーとの互換性はありません。

statesToWaitFor

ビルド状態名のコンマ区切りのリスト。デフォルトは、COMPLETED および INCOMPLETE です。有効な値は次のとおりです。
  • NOT_STARTED: 要求されたビルドは開始されていません。保留中とも見なされます。
  • IN_PROGRESS: ビルドが進行中です。
  • COMPLETED: ビルドは正常に完了されましたがエラーが含まれている可能性があります。
  • CANCELED: ビルド要求は、ビルドが開始される前にキャンセルされました。
  • INCOMPLETE: ビルドは正常に完了しませんでした。中止とも見なされます。

status

IBuildResultContribution に設定される状況。有効な値は、OKERROR、および WARNING です。

タグ

ビルド結果のタグを設定します。ストリング内の個々のタグ は、コンマまたはスペースで区切ります。

targetDirectory

コンテンツの移動先のディレクトリー。

timeout

ビルドでタスクが待機する最長時間。値は秒で表され、ゼロより大きくなければなりません。デフォルトでは永遠に待機します。

timestampFormat

タイム・スタンプのフォーマット。例えば、http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html。 デフォルトは yyyyMMddHHmm です。

url

リンクの URL。

userId

使用するユーザー ID。

verbose

さらにメッセージ出力を指定します。デフォルトは false です。

workspaceUUID

teamAccept タスクでは、変更を受け入れるワークスペースの UUID。

teamFetch タスクでは、取り出し元のワークスペースの UUID。

teamLastModified タスクでは、使用するワークスペース・コンテキストの UUID。

同じ名前の複数のワークスペースがある場合は、workspaceName ではなくこの属性を使用する必要があります。

workspaceName

teamAccept タスクでは、変更を受け入れるワークスペースの名前。

teamFetch タスクでは、取り出し元のワークスペースの名前。

teamLastModified タスクでは、使用するワークスペースの名前。


フィードバック

この情報はお役に立ちましたか? Jazz.net でフィードバックをお送り頂けます (登録が必要です): フォーラムにコメントを記入したり、バグを送信したりすることができます。