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 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.
入力
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 ビルド パイプラインの完全な実行を待たずに、このタスクは正常に完了します。
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 Download Artifacts タスクでこの変数を使用して、この特定のジョブ インスタンスの成果物をダウンロードします。
注釈
このタスクを使用して、Jenkins サーバーでジョブをキュー登録します。
Team Foundation Server プラグイン
Team Foundation Server プラグイン (バージョン 5.2.0 以降) を使用して、自動的に Jenkins ワークスペースからファイルを収集し、ビルドにダウンロードできます。
設定するには:
Team Foundation Server プラグインを Jenkins サーバーにインストールします。
Jenkins サーバーで、結果を収集するジョブごとに、[Azure Pipelines/TFS の結果を収集] ビルド後アクションを追加し、結果の種類の 1 つ以上のペアで構成し、ファイル パターンを含めます。
Jenkins ジョブのキュー登録ビルド タスクで、[コンソール出力を取り込み、完了を待ちます] を有効にしてルート レベル ジョブから結果を収集するか、[パイプライン出力を取り込み、パイプラインの完了を待ちます] を有効にしてすべてのパイプライン ジョブから結果を収集します。
結果は $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results.zip にダウンロードされ、この場所に抽出されます。 プラグインによって収集された結果の種類の各セットは、team-results ディレクトリの下の $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results/ResultType/ にあります。 これは、ビルド結果をダウンストリーム タスク (テスト結果の発行、コード カバレッジ結果の発行など) によって発行できるディレクトリです。
要件
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
実行日 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | 2.144.0 以上 |
タスクのカテゴリ | Build |
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
実行日 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | サポートされているすべてのエージェント バージョン。 |
タスクのカテゴリ | Build |