Ant 属性参考

本主题描述 Jazz™ 团队构建 Ant 任务属性。

下表描述 Jazz 团队构建 Ant 任务属性。

属性 描述

activityId

构建活动的唯一标识。传递到 completeBuildActivity 的 activityId 存放在由 startBuildActivity 任务设置的属性中。请通过使用 ${} 属性值替换语法来指定 activityId 属性值。

activityIdProperty

存储新启动的活动的唯一标识。仅当调用程序打算显式地使用 completeBuildActivity 任务来完成此活动,或者将此活动用作子活动的父代时,此属性才是必需的。

autoComplete

对于 startTeamBuild 任务,指定是否应该自动完成构建。缺省值为 true。 如果此属性为 true,那么启动 Ant 时,必须使用参数 -listener com.ibm.team.build.ant.listener.TeamBuildListener。

对于 startBuildActivity 任务,指定在下列任何情况下是否自动完成活动:父活动完成、下一个对等活动启动或者构建完成。缺省值为 false。

buildDefinitionId

对于 getNextTeamBuildRequest 任务,指定用于查找暂挂中的请求的构建定义标识。如果指定的构建引擎不支持该构建定义标识,那么将不检索请求。

对于 requestTeamBuild 任务,这是所要使用的构建定义的标识。

对于 startTeamBuild 任务,这是要启动的构建的构建定义。仅当未指定 requestUUID 时,此属性才是必需的。

buildDefinitionIdProperty

存储所指定引擎的下一个构建请求的构建定义标识。仅当检索到所指定引擎的请求时,才会定义此属性。如果指定了 buildDefinitionId,那么此属性不适用。

buildLabel

Jazz Build Engine 生成的构建标签。例如,20080215-1234。

buildLabelPrefix

指定构建标签的前缀,例如 I 表示集成。如果在构建定义或构建引擎中定义了此属性,那么将在 Jazz Build Engine 生成的标签前添加此属性的值。例如,I20080215-1234。

buildResultUUID

要更新的构建结果的 UUID。此属性的值通常是 ${buildResultUUID},这是因为,使用 Jazz Build Engine 时,此属性是内置的。

对于 completeBuild 任务,这是要完成的构建结果的 UUID。

对于 teamAccept 任务,这是要用快照信息更新的构建结果。以后,可以使用此快照来重新创建构建工作空间。

对于 teamFetch 任务,将用构建工作空间信息来更新此构建结果。这样,以后就可以根据此构建结果来重新创建构建工作空间。对于每个构建,最多只能在此任务的一次调用过程中设置此属性。 构建结果不能有多个相关联的工作空间。如果构建结果已有相关联的工作空间,那么此任务将抛出异常。

对于 waitForTeamBuild,这是所等待的构建结果的 UUID。通常,如果使用 {@link StartBuildTask}(它在 resultUUIDProperty 属性指定的特性中返回构建结果 UUID)来启动构建,那么指定此 UUID。

buildNotNecessary

如果不必执行构建,那么设置为 true。例如,如果源代码自从上次构建后未改动,那么不必执行构建。您只需要在控制整个构建生命周期的 Ant 脚本中使用此属性。

buildStateProperty

当任务完成等待时,将把构建状态写入此属性。仅当构建进入其中一种要等待的所指定状态时,才会设置此属性。

buildStatusProperty

此属性被赋予构建状态,值为 OK、INFO、WARNING 或 ERROR。

changeSetFile

此文件用于存储序列化的变更集。

changesAcceptedProperty

存储已接受的变更集的数目。仅当已至少接受一个变更集时,才会定义并设置此属性。

componentMap

“包名到组件”映射信息所在文件的路径。

“包名到组件”映射信息所在文件的路径。包名必须与测试套件类的包匹配。

componentName

要与此添加项相关联的特定组件。

contentType

工件的类型。如果未指定此属性,那么它将设置为 application/unknown。

对于 filePublisher 任务,这是工件的类型。如果未指定此属性,那么缺省值为 application/unknown。

对于 logPublisher 任务,这是工件的类型。如果未指定此属性,那么缺省值为 text/plain。

contributionTypeId

此添加项的扩展添加项类型标识。

characterEncoding

工件文件中使用的字符编码。它必须是与 IANA 一致的名称。缺省情况下,这是当前平台的缺省编码。有关更多信息,请参阅字符集名称的 IANA 列表

deletePropertiesFile

属性文件的路径。此属性文件指定运行构建时应该省略的属性。这些属性被假定存在于构建定义中。此路径可以是起始于构建文件的基本目录的相对路径,也可以是完整路径。

deleteAllowed

设置是否可以删除构建结果。

destination

用于存储所访存文件的本地目录。

engineId

对于 getNextTeamBuildRequest 任务,这是要为其检索下一个构建请求的构建引擎的标识。

对于 startTeamBuild 任务,这是运行构建的构建引擎的标识。仅当未指定 requestUUID 时,此属性才是必需的。

failOnError

如果设置为 true(缺省值),那么任务遇到错误时将失败。如果设置为 false,那么某些错误将被忽略,任务将完成。

filePath

对于需要输入文件的任务,此属性指定文件的路径。这可以是绝对路径,也可以是相对于构建文件的基本目录的路径。

XML 日志的路径或者 XML 日志所在目录的路径。此路径可以是起始于构建文件的基本目录的相对路径,也可以是完整路径。

对于 jdtCompileLogPublisher 任务,这是 JDT 编译器日志文件的路径或者要发布的文件的目录。

对于 filePublisher 任务,这是文件的路径或者要发布的文件的目录。

对于 workItemPublisher 任务,请设置为 teamAccept 任务的变更集文件输出的路径或者工作项文件的路径。工作项文件的每一行都必须包含一个工作项标识。此路径可以相对于构建文件的基本目录,也可以是绝对路径。

对于 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

用户标识的密码,缺省情况下,除非另有指定,否则是长度为零的字符串。

passwordFile

用于建立连接的密码文件。您可以通过在调用 Jazz Build Engine 时指定 -createPasswordFile 参数来创建适当的密码文件。只能指定一个密码文件。

pdeBuild

如果设置为 true,那么发布程序将日志目录结构解释为由 PDE 构建生成。在层次结构中的所给定 filePath 下,必须存在一个 plug-ins 目录。发布程序按插件对各个包进行分组。

rawOutputPropertiesFile

属性文件的路径。此路径可以是起始于构建文件的基本目录的相对路径,也可以是完整路径。此属性文件包含内部文件夹和基线标识,后者描述“sourceDirectory”中每个文件夹的最新基线。

requestUUID

指定启动构建时要使用的现有构建请求。如果指定此属性,那么不能指定 buildDefinitionID 和 engineID。

对于 waitForTeamBuild,这是所等待的构建请求的 UUID。通常,如果使用 {@link RequestBuildTask}(它在 requestUUIDProperty 属性指定的特性中返回构建请求 UUID)来请求构建,那么指定此 UUID。

requestUUIDFile

文件的路径,此文件用于存储所指定构建引擎的下一个构建请求的 UUID。此路径可以相对于构建文件的基本目录,也可以是完整路径。此文件被格式化为 java.util.Properties 格式,并包含一个名称由 requestUUIDProperty 指定的属性。

requestUUIDProperty

存储检索到的构建请求的 UUID。仅当找到请求时,才会设置此属性。

repositoryAddress

要使用的团队存储库的地址。此属性的值通常是 ${repositoryAddress},这是因为,使用 Jazz Build Engine 时,此属性是内置的。

resultUUIDFile

用于存储构建结果的文件。此路径可以是构建文件的基本目录的相对路径,也可以是完整路径。此文件被格式化为 java.util.Properties 格式,并包含一个名称由 resultUUIDProperty 指定的属性。

resultUUIDProperty

用于存储构建结果的 UUID 的属性。

snapshotName

在工作空间中创建的快照的名称。

snapshotUUIDProperty

提供属性名,此属性名用于访问所创建的快照的 UUID。

sourceDirectory

对于 pluginOrganizer 任务,这是要使用的源目录。此目录被假定带有插件和功能部件目录。

对于 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

要使用的用户标识。

verbose

指定更多消息输出。缺省值为 false。

workspaceUUID

对于 teamAccept 任务,这是要将变更接受到的工作空间的 UUID。

对于 teamFetch 任务,这是要从中执行访存的工作空间的 UUID。

对于 teamLastModified 任务,这是要使用的工作空间上下文的 UUID。

如果有多个同名的工作空间,那么可能需要使用此属性来代替 workspaceName。

workspaceName

对于 teamAccept 任务,这是要将变更接受到的工作空间的名称。

对于 teamFetch 任务,这是要从中执行访存的工作空间的名称。

对于 teamLastModified 任务,这是要使用的工作空间的名称。


反馈

本资料对您是否有帮助?您可以在 Jazz.net 上提供反馈(需要注册):在论坛中发表意见或者提交错误