JenkinsQueueJob@1 - Jenkins 佇列作業 v1 工作
使用此工作將 Jenkins 伺服器上的作業排入佇列。
Syntax
# 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 認可標識碼,您可以使用: commitId=$(Build.SourceVersion)
。 如需詳細資訊,請參閱 變數的檔。
支援的 Jenkins 參數型態如下:
Boolean
Choice
Password
String
工作控制選項
除了工作輸入之外,所有工作都有控制選項。 如需詳細資訊,請參閱 控件選項和一般工作屬性。
輸出變數
無。
規格需求
需求 | 描述 |
---|---|
管線類型 | YAML、傳統組建、傳統版本 |
執行於 | Agent、DeploymentGroup |
要求 | 無 |
Capabilities | 此工作不符合作業中後續工作的任何需求。 |
命令限制 | 任何 |
Settable 變數 | 任何 |
代理程式版本 | 所有支援的代理程式版本。 |
工作類別 | 建置 |