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

任务控制选项

除了任务输入,所有任务都有控制选项。 有关详细信息,请参阅 控制选项和常见任务属性

输出变量

无。

要求

要求 说明
管道类型 YAML、经典版本、经典版本
运行平台 Agent、DeploymentGroup
需求
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任意
可设置变量 任意
代理版本 所有支持的代理版本。
任务类别 构建