このタスクを使用して、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.
入力
Jenkins サービス エンドポイントの serverEndpoint
-
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
するときに使用します。
1 行に 1 つずつジョブ パラメーターを指定します (例: <parameterName>=<parameterValue>
)。
既定値のオーバーライドに役立つ空の値にパラメーターを設定するには、パラメーター値をオフのままにします。 たとえば、<parameterName>=
と指定します。
変数がサポートされています。
commitId
パラメーター値をビルドの Git コミット ID に設定するには、たとえば、commitId=$(Build.SourceVersion)
を使用できます。 詳細については、変数 に関するドキュメントを参照してください。
サポートされている Jenkins パラメーターの型は次のとおりです。
Boolean
Choice
Password
String
タスク コントロールのオプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。
出力変数
なし。