JenkinsQueueJob@1 - Jenkins 队列作业 v1 任务
使用此任务在 Jenkins 服务器上对作业进行排队。
语法
# Jenkins Queue Job v1
# Queue a job on a Jenkins server.
- task: JenkinsQueueJob@1
inputs:
serverEndpoint: # string. Required. Jenkins service endpoint.
jobName: # string. Required. Job name.
#isMultibranchJob: false # boolean. Job is of Multibranch Pipeline type. Default: false.
#multibranchPipelineBranch: # string. Required when isMultibranchJob = true. Multibranch Pipeline Branch.
#captureConsole: true # boolean. Capture console output and wait for completion. Default: true.
#capturePipeline: true # boolean. Optional. Use when captureConsole = true. Capture pipeline output and wait for pipeline completion. Default: true.
# Advanced
#parameterizedJob: false # boolean. Parameterized job. Default: false.
#jobParameters: # string. Optional. Use when parameterizedJob = true. Job parameters.
输入
serverEndpoint
-
Jenkins 服务终结点
string
。 必填。
指定 Jenkins 实例的服务终结点。 单击“管理”链接(使用任务助手时)创建新的 Jenkins 服务终结点。
jobName
-
作业名称
string
。 必填。
要排队的 Jenkins 作业的名称。 这必须与 Jenkins 服务器上的作业名称完全匹配。
isMultibranchJob
-
作业是多台管道类型
boolean
。 默认值:false
。
此作业是多台管道。 如果指定,请添加相应的分支名称。 此输入需要适用于 Jenkins v5.3.4 或更高版本的 Team Foundation Server 插件。
multibranchPipelineBranch
-
多分支管道分支
string
。
isMultibranchJob = true
时是必需的。
将此多分支管道作业排在指定的分支上。 此输入需要适用于 Jenkins v5.3.4 或更高版本的 Team Foundation Server 插件。
captureConsole
-
捕获控制台输出并等待完成
boolean
。 默认值:true
。
如果指定,此输入将捕获 Jenkins 生成控制台输出,等待 Jenkins 生成完成,并基于 Jenkins 生成结果成功/失败。 否则,在 Jenkins 作业排队后,此步骤将成功完成,无需等待 Jenkins 生成运行。
capturePipeline
-
捕获管道输出并等待管道完成
boolean
。 可选。 当 captureConsole = true
时使用。 默认值:true
。
如果指定,此输入将捕获完整的 Jenkins 生成管道控制台输出,等待完整的 Jenkins 生成管道完成,并根据 Jenkins 生成管道结果成功/失败。 否则,一旦第一个 Jenkins 作业完成,此输入将成功完成,而无需等待完整的 Jenkins 生成管道运行。
parameterizedJob
-
参数化作业
boolean
。 默认值:false
。
指定 Jenkins 作业是否接受参数。 即使使用所有默认参数值且实际未指定任何参数,也使用此输入。
jobParameters
-
作业参数
string
。 可选。 当 parameterizedJob = true
时使用。
指定每行一个作业参数,例如:<parameterName>=<parameterValue>
。
若要将参数设置为空值,这对于重写默认值很有用,请保留参数值。 例如,指定 <parameterName>=
。
支持变量。 若要将 commitId
参数值设置为生成的 Git 提交 ID,例如,可以使用:commitId=$(Build.SourceVersion)
。 有关详细信息,请参阅有关变量 文档。
支持的 Jenkins 参数类型包括:
Boolean
Choice
Password
String
任务控制选项
除任务输入之外,所有任务都具有控制选项。 有关详细信息,请参阅 控件选项和常见任务属性。
输出变量
没有。