Share via

JenkinsQueueJob@1 - Tâche de file d’attente Jenkins v1

  • Article

Utilisez cette tâche pour mettre en file d’attente un travail sur un serveur 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.

Entrées

serverEndpoint - Point de terminaison de service Jenkins
string. Obligatoire.

Spécifie le point de terminaison de service pour votre instance Jenkins. Cliquez sur le lien Gérer (lorsque vous utilisez la tâche assistant) pour créer un point de terminaison de service Jenkins.


jobName - Nom du travail
string. Obligatoire.

Nom du travail Jenkins à mettre en file d’attente. Il doit correspondre exactement au nom du travail sur le serveur Jenkins.


isMultibranchJob - Le travail est de type pipeline multibranch
boolean. Valeur par défaut : false.

Ce travail est un pipeline multibranche. Si cette option est spécifiée, ajoutez le nom de branche approprié. Cette entrée nécessite le plug-in Team Foundation Server pour Jenkins v5.3.4 ou version ultérieure.


multibranchPipelineBranch - Branche de pipeline multibranch
string. Nécessaire lorsque isMultibranchJob = true.

Met en file d’attente ce travail de pipeline multibranch sur la branche spécifiée. Cette entrée nécessite le plug-in Team Foundation Server pour Jenkins v5.3.4 ou version ultérieure.


captureConsole - Capturer la sortie de la console et attendre l’achèvement
boolean. Valeur par défaut : true.

Si elle est spécifiée, cette entrée capture la sortie de la console de build Jenkins, attend la fin de la build Jenkins et réussit/échoue en fonction du résultat de la build Jenkins. Sinon, une fois le travail Jenkins mis en file d’attente, cette étape se termine sans attendre l’exécution de la build Jenkins.


capturePipeline - Capturer la sortie du pipeline et attendre l’achèvement du pipeline
boolean. facultatif. Utilisez quand captureConsole = true. Valeur par défaut : true.

Si elle est spécifiée, cette entrée capture la sortie complète de la console du pipeline de build Jenkins, attend que le pipeline de build Jenkins complet se termine et réussit/échoue en fonction du résultat du pipeline de build Jenkins. Sinon, une fois le premier travail Jenkins terminé, cette entrée se termine correctement sans attendre l’exécution complète du pipeline de build Jenkins.


parameterizedJob - Travail paramétrable
boolean. Valeur par défaut : false.

Spécifie si le travail Jenkins accepte les paramètres. Utilisez cette entrée même si toutes les valeurs de paramètre par défaut sont utilisées et qu’aucun paramètre n’est réellement spécifié.


jobParameters - Paramètres de travail
string. facultatif. Utilisez quand parameterizedJob = true.

Spécifie les paramètres de travail avec un par ligne, par exemple : <parameterName>=<parameterValue>.

Pour définir un paramètre sur une valeur vide, ce qui est utile pour remplacer une valeur par défaut, laissez la valeur du paramètre de côté. Par exemple, spécifiez <parameterName>=.

Les variables sont prises en charge. Pour définir une commitId valeur de paramètre sur l’ID de validation Git de la build, par exemple, vous pouvez utiliser : commitId=$(Build.SourceVersion). Pour plus d’informations, consultez la documentation sur les variables.

Les types de paramètres Jenkins pris en charge sont les suivants :

  • Boolean
  • Choice
  • Password
  • String

Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes None
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent Toutes les versions d’agent prises en charge.
Catégorie de la tâche Build