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 作業,則為要用的建置定義的 ID。

如果是 startTeamBuild 作業,則為要啟動之建置的建置定義。 如果未指定 requestUUID,便屬必要。

buildDefinitionIdProperty

儲存所指定引擎下一個建置要求的建置定義 ID。 只有在擷取指定引擎的要求時,才加以定義。 如果指定了 buildDefinitionId,便不會套用。

buildLabel

Jazz Build Engine 所產生的建置標籤。 例如,20080215-1234。

buildLabelPrefix

指定建置標籤的字首,如 I 代表整合。 如果您在建置定義或建置引擎中定義這個內容,值會附加到 Jazz Build Engine 產生的標籤前面。 例如,I20080215-1234。

buildResultUUID

要更新之建置結果的 UUID。 這個屬性的值通常是 ${buildResultUUID},因為在使用 Jazz Build Engine 時,內容是內建的。

如果是 completeBuild 作業,則為要完成之建置結果的 UUID。

如果是 teamAccept 作業,則建置結果會以 Snapshot 資訊更新。 Snapshot 可在稍後用來重建建置工作區。

如果是 teamFetch 作業,這個建置結果將會以建置工作區資訊更新。 如此一來,稍後便能夠從建置結果重建建置工作區。 每項建置最多只應在這項作業的單一呼叫上設定這個屬性。 建置結果不能有多個相關聯的工作區。 如果建置結果已有相關聯的工作區,這項作業會擲出異常狀況。

如果是 waitForTeamBuild,則為等待之建置結果的 UUID。如果是以 {@link StartBuildTask} 來啟動建置,通常會指定此項,而這會傳回 resultUUIDProperty 屬性所指定內容中的建置結果 UUID。

buildNotNecessary

如果不需要建置,請設為 true。 比方說,如果前次建置之後,程式碼不曾變更,便不需要建置。 這個屬性只能在控制整個建置生命週期的 Ant Script 中使用。

buildStateProperty

在作業完成等待時,寫入建置狀態的內容。 只在建置進入其中一個指定等待狀態時,才加以設定。

buildStatusProperty

將建置狀態指派給內容,其值可為「完成」、「參考」、「警告」或「錯誤」其中之一。

changeSetFile

用來儲存已序列化之變更集的檔案。

changesAcceptedProperty

儲存接受的變更集數目。 只在接受至少一個變更集時,才定義和設定這個內容。

componentMap

含有「套件名稱至元件」對映資訊之檔案的路徑。

含有「套件名稱至元件」對映資訊之檔案的路徑。套件名稱必須符合測試套組類別的套件。

componentName

要關聯於這個要素項的特定元件。

contentType

構件的類型。 如果沒有指定,它會設為 application/unknown。

如果是 filePublisher 作業,則為構件的類型。 如果沒有指定,預設值是 application/unknown。

如果是 logPublisher 作業,則為構件的類型。 如果沒有指定,預設值是 text/plain。

contributionTypeId

這個要素項的延伸要素項類型 ID。

characterEncoding

構件檔所用的字元編碼。 它必須是 IANA 標準名稱。 預設值是現行平台的預設編碼。 如需相關資訊,請參閱字集名稱的 IANA 清單

deletePropertiesFile

內容檔的路徑。 這個內容檔指定執行建置時所應省略的內容。 假設內容是在建置定義中。 這個路徑可以是起始於建置檔基本目錄的相對路徑,也可以是完整路徑。

deleteAllowed

設定是否可以刪除建置結果。

destination

儲存提取之檔案的本端目錄。

engineId

如果是 getNextTeamBuildRequest 作業,這是要擷取下一建置要求之建置引擎的 ID。

如果是 startTeamBuild 作業,則為執行建置的建置引擎 ID。 如果未指定 requestUUID,便是必要。

failOnError

如果是 true(預設值),當發生錯誤時,作業會失敗。 如果是 false,會忽略某些錯誤,並完成作業。

filePath

如果是需要輸入檔的作業,這用來指定檔案路徑。 可以是絕對可以是絕對路徑,或建置檔基本目錄的相對路徑。

XML 日誌的路徑,或是含有 XML 日誌的目錄路徑。這個路徑可以是起始於建置檔基本目錄的相對路徑,也可以是完整路徑。

如果是 jdtCompileLogPublisher 作業,這是要發佈的 JDT 編譯器日誌檔或檔案目錄的路徑。

如果是 filePublisher 作業,則為要發佈之檔案或檔案目錄的路徑。

如果是 workItemPublisher 作業,這設為 teamAccept 作業之變更集檔案輸出或工作項目檔的路徑。 工作項目檔必須包含工作項目 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

用來作為母項之現有活動的 ID。 這個 ID 的活動必須存在,且尚未完成。

password

使用者 ID 的密碼,除非另有指定,否則,預設為零長度的字串。

passwordFile

連線所用的密碼檔。 您可以利用 -createPasswordFile 引數呼叫 Jazz Build Engine 來建立適當的密碼檔。 您只能指定一個密碼檔。

pdeBuild

如果是 true,發佈者便將日誌目錄結構解譯為是 pde 建置所產生。 必須有一個外掛程式目錄出現在給定 filePath 之下的階層中。 發佈者依外掛程式將套件分組。

rawOutputPropertiesFile

內容檔的路徑。 這個路徑可以是起始於建置檔基本目錄的相對路徑,也可以是完整路徑。 這個內容檔包含內部資料夾和基準線 ID,以說明 sourceDirectory 中每個資料夾的最新基準線。

requestUUID

指定在啟動建置時所用的現有建置要求。 如果已指定,則無法指定 buildDefinitionID 和 engineID。

如果是 waitForTeamBuild,則為等待之建置要求的 UUID。如果是以 {@link RequestBuildTask} 來要求建置,通常會指定此項,而這會傳回 requestUUIDProperty 屬性所指定內容中的建置要求 UUID。

requestUUIDFile

用來儲存指定建置引擎下一建置要求之 UUID 的檔案路徑。 這個路徑可以是建置檔基本目錄的相對路徑或是完整路徑。 檔案採用 java.util.Properties 格式,含有 requestUUIDProperty 屬性指定名稱的內容。

requestUUIDProperty

儲存所擷取之建置要求的 UUID。 只在找到要求時才設定。

repositoryAddress

要用的團隊儲存庫的位址。 這個屬性的值通常是 ${repositoryAddress},因為使用 Jazz Build Engine 時,內容是內建的。

resultUUIDFile

用來儲存建置結果的檔案。 這個路徑可以是建置檔基本目錄的相對路徑,也可以是完整路徑。 檔案採用 java.util.Properties 格式,含有 resultUUIDProperty 屬性指定名稱的內容。

resultUUIDProperty

用來儲存建置結果 UUID 的內容。

snapshotName

工作區中所建立之 Snapshot 的名稱。

snapshotUUIDProperty

提供內容名稱來存取所建 Snapshot 的 UUID。

sourceDirectory

如果是 pluginOrganizer 作業,則為要使用的來源目錄。 假設它含有 plugin 和 feature 目錄。

如果是 teamLastModified 作業,則為位在本端檔案系統的目錄位置。 sourceDirectory 屬性值必須是 Jazz 儲存庫 工作區的根。 比方說,如果 teamFetch 作業提取到 c:\fetched,則 teamLastModified 中的 sourceDirectory 應該是 c:\fetched。 這項作業不相容於 scmtools 指令行公用程式。

statesToWaitFor

逗點區隔的建置狀態名稱清單。 預設值是 COMPLETED 和 INCOMPLETE。 有效值如下:
  • NOT_STARTED:未啟動要求的建置。也稱為擱置中。
  • IN_PROGRESS:建置在進行中。
  • COMPLETED:建置已正常完成,但可能包含錯誤。
  • CANCELED:在建置啟動之前,已取消建置要求。
  • INCOMPLETE:建置未正常完成。也稱為放棄。

status

IBuildResultContribution 中所設定的狀態。有效值為 OKERRORWARNING

tags

設定建置結果的標籤。字串中的個別標籤以逗點或空格區隔。

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 網站中提供意見(需要登錄):在討論區中提供意見提交錯誤