JenkinsQueueJob@2 - Tâche de file d’attente Jenkins v2

Utilisez cette tâche pour mettre en file d’attente un travail sur un serveur Jenkins.

Syntax

# 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.

Entrées

serverEndpoint - Connexion au service Jenkins
string. Obligatoire.

Spécifie la connexion de service pour votre instance Jenkins. Cliquez sur le lien Gérer pour créer une connexion 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 spécifié, 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 multibranche 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 la tâche Jenkins mise en file d’attente, cette tâche se termine correctement sans attendre l’exécution de la build Jenkins.

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

Si elle est spécifiée, cette tâche 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 tâche se termine correctement sans attendre l’exécution complète du pipeline de build Jenkins.

isParameterizedJob - Travail paramétré
Alias d’entrée : parameterizedJob. 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 du travail
string. facultatif. Utilisez quand parameterizedJob = true.

Spécifie les paramètres de travail, avec un par ligne, au format .<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 de paramètre désactivée. 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

failOnUnstableResult - Échec sur un résultat instable
boolean. Valeur par défaut : false.

Spécifie la rigueur d’une définition de réussite, ou indique s’il faut ou non considérer l’instabilité comme une défaillance. La false valeur correspond à une version non stricte et la true est à une version stricte. Si la valeur trueest définie sur , un résultat de build instable est traité comme un échec. Sinon, un résultat instable est traité comme un succès.

retryCount - Nombre de nouvelles tentatives pour l’échec de la connexion
string. Valeur par défaut : 3.

Spécifie le nombre de nouvelles tentatives de connexion en cas d’échec ou d’erreur de connexion.

delayBetweenRetries - Temps entre les nouvelles tentatives
string. Valeur par défaut : 60.

Spécifie le délai entre les nouvelles tentatives de connexion lorsqu’une erreur se produit. Cette valeur est exprimée en secondes.

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

Cette tâche définit les variables de sortie suivantes, que vous pouvez utiliser dans les étapes, les travaux et les étapes en aval.

JENKINS_JOB_ID
L’ID du travail Jenkins instance mis en file d’attente par cette tâche. Utilisez cette variable dans la tâche Télécharger les artefacts Jenkins pour télécharger les artefacts de ce travail particulier instance.

Remarques

Utilisez cette tâche pour mettre en file d’attente un travail sur un serveur Jenkins.

Plug-in Team Foundation Server

Vous pouvez utiliser le plug-in Team Foundation Server (version 5.2.0 ou ultérieure) pour collecter automatiquement des fichiers dans l’espace de travail Jenkins et les télécharger dans la build.

Pour le configurer :

1. Installez le plug-in Team Foundation Server sur le serveur Jenkins.

2. Sur le serveur Jenkins, pour chaque travail dont vous voulez collecter les résultats, ajoutez l’action de post-build Collecter les résultats pour Azure Pipelines/TFS, puis configurez-la avec une ou plusieurs paires de types de résultat et incluez le modèle de fichier.

3. Dans la tâche de build Mettre en file d’attente le travail Jenkins, activez Capturer la sortie de console et attendre la fin de l’exécution pour collecter les résultats du travail de niveau racine, ou Capturer la sortie de pipeline et attendre la fin de l’exécution du pipeline pour collecter les résultats de tous les travaux de pipeline.

Les résultats sont téléchargés dans $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results.zip et extraits à cet endroit. Chaque ensemble de types de résultats collectés par le plug-in se trouve sous le répertoire team-results, $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results/ResultType/. Il s’agit du répertoire où les résultats de build peuvent être publiés par des tâches en aval (par exemple, Publier les résultats de test et Publier des résultats de couverture du code).

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 commandes	Quelconque
Variables settables	Quelconque
Version de l’agent	2.144.0 ou version ultérieure
Catégorie de la tâche	Build