JenkinsQueueJob@1 - Jenkins Queue Job 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を使用します。

1 行に 1 つずつジョブ パラメーターを指定します (例: <parameterName>=<parameterValue>)。

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

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

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

  • Boolean
  • Choice
  • Password
  • String

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

[なし] :

必要条件

要件 説明
パイプラインの種類 YAML、クラシック ビルド、クラシック リリース
上で実行 エージェント、DeploymentGroup
確認要求 なし
Capabilities このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限 Any
設定可能な変数 Any
エージェントのバージョン サポートされているすべてのエージェント バージョン。
タスクのカテゴリ Build