JenkinsQueueJob@2 - Jenkins キュー ジョブ v2 タスク

このタスクを使用して、Jenkins サーバー上のジョブをキューに入れます。

# Jenkins queue job v2
# Queue a job on a Jenkins server.
- task: JenkinsQueueJob@2
  inputs:
    serverEndpoint: # string. Required. Jenkins service connection. 
    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
    #isParameterizedJob: false # boolean. Alias: parameterizedJob. Parameterized job. Default: false.
    #jobParameters: # string. Optional. Use when parameterizedJob = true. Job parameters. 
    #failOnUnstableResult: false # boolean. Fail on unstable result. Default: false.
    #retryCount: '3' # string. Number of retries for failed connection. Default: 3.
    #delayBetweenRetries: '60' # string. Time between retries. Default: 60.

# Jenkins queue job v2
# Queue a job on a Jenkins server.
- task: JenkinsQueueJob@2
  inputs:
    serverEndpoint: # string. Required. Jenkins service connection. 
    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
    #isParameterizedJob: false # boolean. Alias: parameterizedJob. 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 ビルド パイプラインが実行されるのを待たずに、このタスクが正常に完了します。

パラメーター化されたジョブの isParameterizedJob -
入力エイリアス: parameterizedJob。 boolean。 既定値: false.

Jenkins ジョブがパラメーターを受け入れるかどうかを指定します。 すべての既定のパラメーター値が使用され、パラメーターが実際に指定されていない場合でも、この入力を使用します。

ジョブ パラメーターを jobParameters - する
string。 任意 parameterizedJob = trueするときに使用します。

ジョブ パラメーターを 1 行に 1 つずつ、<parameterName>=<parameterValue>の形式で指定します。

既定値のオーバーライドに役立つ空の値にパラメーターを設定するには、パラメーター値をオフのままにします。 たとえば、parameterName= と指定します。

変数がサポートされています。 commitId パラメーター値をビルドの Git コミット ID に設定するには、たとえば、commitId=$(Build.SourceVersion)を使用できます。 詳細については、変数 に関するドキュメントを参照してください。

サポートされている Jenkins パラメーターの型は次のとおりです。

• Boolean
• Choice
• Password
• String

failOnUnstableResult - 不安定な結果 で失敗する
boolean。 既定値: false.

成功定義の厳密さを指定するか、不安定な定義を失敗と見なすかどうかを指定します。 false 値は厳密でないバージョン用であり、true は厳密なバージョン用です。 trueに設定すると、不安定なビルド結果がエラーとして扱われます。 それ以外の場合、不安定な結果は成功として扱われます。

retryCount - 失敗した接続 の再試行回数
string。 既定値: 3.

接続エラーまたはエラーが発生した場合の接続再試行の量を指定します。

delayBetweenRetries - 再試行 間の時間
string。 既定値: 60.

エラーが発生したときの接続再試行の間隔を指定します。 この値は秒単位で指定します。

このタスクでは、次の 出力変数を定義します。この変数は、ダウンストリームのステップ、ジョブ、およびステージで使用できます。

JENKINS_JOB_ID
このタスクによってキューに登録されている Jenkins ジョブ インスタンスの ID。 Jenkins 成果物のダウンロード タスクでこの変数を使用して、この特定のジョブ インスタンスの成果物をダウンロードします。