Partager via


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

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

Syntaxe

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

Entrées

serverEndpoint - connexion de 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. Cela doit correspondre exactement au nom du travail sur le serveur Jenkins.


isMultibranchJob - Job est de type de pipeline multibranche
boolean. Valeur par défaut : false.

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


multibranchPipelineBranch - branche de pipeline multibranche
string. Obligatoire 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.


sortie de la console capture captureConsole - 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 les files d’attente de travaux Jenkins terminées, cette tâche 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. Optionnel. 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 de pipeline de build Jenkins, attend la fin du pipeline de build Jenkins complet et réussit/échoue en fonction du résultat du pipeline de build Jenkins. Sinon, une fois la première tâche Jenkins terminée, cette tâche se termine correctement sans attendre l’exécution du pipeline de build Jenkins complet.


isParameterizedJob - travail paramétrable
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 de travail
string. Optionnel. Utilisez quand parameterizedJob = true.

Spécifie les paramètres de travail, avec une par ligne, au format de <parameterName>=<parameterValue>.

Pour définir un paramètre sur une valeur vide, qui est utile pour remplacer une valeur par défaut, laissez la valeur du paramètre désactivée. Par exemple, spécifiez parameterName=.

Les variables sont prises en charge. Pour définir une valeur de paramètre commitId 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 le 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 considérer comme un échec ou non. La valeur false est destinée à une version non stricte, et la true correspond à une version stricte. Si la valeur est true, 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 une connexion ayant échoué
string. Valeur par défaut : 3.

Spécifie la quantité de nouvelles tentatives de connexion lors de l’échec ou de l’erreur de connexion.


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

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


Options de contrôle de tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâche. 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 en aval, les travaux et les étapes.

JENKINS_JOB_ID
L’ID de l’instance de travail Jenkins mise en file d’attente par cette tâche. Utilisez cette variable dans la tâche Jenkins Download Artifacts pour télécharger les artefacts pour cette instance de travail particulière.

Remarques

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

Team Foundation Server Plug-in

Vous pouvez utiliser le plug-in Team Foundation Server (version 5.2.0 ou ultérieure) pour collecter automatiquement des fichiers à partir de 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 à partir duquel vous souhaitez collecter les résultats, ajoutez le Collecter les résultats pour Azure Pipelines/TFS action post-build, puis configurez-le avec une ou plusieurs paires de types de résultats et incluez le modèle de fichier.

  3. Dans le travail de file d’attente Jenkins, la tâche de génération active la sortie de la console de capture et attendez que l’achèvement collecte des résultats à partir du travail de niveau racine, ou la sortie du pipeline de capture et attendez que l’achèvement du pipeline soit terminé pour collecter les résultats de tous les travaux de pipeline.

Les résultats seront téléchargés dans le $(Build.StagingDirectory)/jenkinsResults/Nom du travail/team-results.zip et extraits à cet emplacement. 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 dans lequel les résultats de build peuvent être publiés par des tâches en aval (par exemple, Publier les résultats des tests et publier des résultats de couverture du code).

Spécifications

Besoin Descriptif
Types de pipelines YAML, Build Classique, Version Classique
Exécutions sur Agent, DeploymentGroup
demandes Aucun
fonctionnalités de Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande N'importe quel
variables settables N'importe quel
Version de l’agent 2.144.0 ou version ultérieure
Catégorie de tâche Construire
Besoin Descriptif
Types de pipelines YAML, Build Classique, Version Classique
Exécutions sur Agent, DeploymentGroup
demandes Aucun
fonctionnalités de Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande N'importe quel
variables settables N'importe quel
Version de l’agent Toutes les versions de l’agent prises en charge.
Catégorie de tâche Construire