JenkinsQueueJob@2 – Aufgabe "Jenkins queue job v2"

Verwenden Sie diese Aufgabe, um einen Auftrag auf einem Jenkins-Server in die Warteschlange zu stellen.

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.

Eingaben

serverEndpoint - Jenkins-Dienstverbindung
string. Erforderlich.

Gibt die Dienstverbindung für Ihre Jenkins-instance an. Klicken Sie auf den Link Verwalten, um eine neue Jenkins-Dienstverbindung zu erstellen.

jobName - Auftragsname
string. Erforderlich.

Der Name des Jenkins-Auftrags, der in die Warteschlange gestellt werden soll. Dieser muss genau mit dem Auftragsnamen auf dem Jenkins-Server übereinstimmen.

isMultibranchJob - Der Auftrag ist vom Typ "Multibranch"-Pipeline.
boolean. Standardwert. false.

Bei diesem Auftrag handelt es sich um eine Mehrbranch-Pipeline. Wenn angegeben, fügen Sie den entsprechenden Branchnamen hinzu. Für diese Eingabe ist das Team Foundation Server-Plug-In für Jenkins v5.3.4 oder höher erforderlich.

multibranchPipelineBranch - Multibranch-Pipelinebranch-Branch
string. Erforderlich, wenn isMultibranchJob = true.

Stellt diesen Mehrbranch-Pipelineauftrag in die Warteschlange im angegebenen Branch. Für diese Eingabe ist das Team Foundation Server-Plug-In für Jenkins v5.3.4 oder höher erforderlich.

captureConsole - Erfassen der Konsolenausgabe und Warten auf den Abschluss
boolean. Standardwert. true.

Falls angegeben, erfasst diese Eingabe die Ausgabe der Jenkins-Buildkonsole, wartet auf den Abschluss des Jenkins-Builds und schlägt basierend auf dem Jenkins-Buildergebnis erfolgreich bzw. fehl. Andernfalls wird dieser Task erfolgreich abgeschlossen, sobald der Jenkins-Auftrag in die Warteschlange gestellt wurde, ohne auf die Ausführung des Jenkins-Builds zu warten.

capturePipeline - Erfassen der Pipelineausgabe und Warten auf den Abschluss der Pipeline
boolean. Optional. Verwenden Sie , wenn captureConsole = true. Standardwert. true.

Wenn angegeben, erfasst dieser Task die vollständige Ausgabe der Jenkins-Buildpipelinekonsole, wartet, bis die vollständige Jenkins-Buildpipeline abgeschlossen ist, und führt basierend auf dem Ergebnis der Jenkins-Buildpipeline einen Erfolgreichen/Fehler aus. Andernfalls wird dieser Task nach Abschluss des ersten Jenkins-Auftrags erfolgreich abgeschlossen, ohne auf die Ausführung der vollständigen Jenkins-Buildpipeline zu warten.

isParameterizedJob - Parametrisierter Auftrag
Eingabealias: parameterizedJob. boolean. Standardwert. false.

Gibt an, ob der Jenkins-Auftrag Parameter akzeptiert. Verwenden Sie diese Eingabe auch dann, wenn alle Standardparameterwerte verwendet werden und keine Parameter angegeben werden.

jobParameters - Auftragsparameter
string. Optional. Verwenden Sie , wenn parameterizedJob = true.

Gibt Auftragsparameter mit einem pro Zeile im Format an <parameterName>=<parameterValue>.

Um einen Parameter auf einen leeren Wert festzulegen, der zum Überschreiben eines Standardwerts nützlich ist, lassen Sie den Parameterwert weg. Geben Sie beispielsweise an parameterName=.

Variablen werden unterstützt. Um einen commitId Parameterwert auf die Git-Commit-ID des Builds festzulegen, können Sie beispielsweise folgendes verwenden: commitId=$(Build.SourceVersion). Weitere Informationen finden Sie in der Dokumentation zu Variablen.

Die unterstützten Jenkins-Parametertypen sind:

• Boolean
• Choice
• Password
• String

failOnUnstableResult - Fehler beim instabilen Ergebnis
boolean. Standardwert. false.

Gibt die Strenge einer Erfolgsdefinition an oder gibt an, ob instabil als Fehler betrachtet werden soll oder nicht. Der false Wert ist für eine nicht strikte Version und die true für eine strenge Version. Wenn dieser Wert auf truefestgelegt ist, wird ein instabiles Buildergebnis als Fehler behandelt. Andernfalls wird ein instabiles Ergebnis als Erfolg behandelt.

retryCount - Anzahl von Wiederholungsversuchen für eine fehlgeschlagene Verbindung
string. Standardwert. 3.

Gibt die Anzahl von Verbindungsversuchen an, wenn ein Verbindungsfehler oder -fehler auftritt.

delayBetweenRetries - Zeit zwischen Wiederholungen
string. Standardwert. 60.

Gibt die Zeitspanne zwischen Verbindungsversuchen an, wenn ein Fehler auftritt. Der Wert wird in Sekunden angegeben.

Optionen für die Vorgangskontrolle

Alle Vorgänge verfügen zusätzlich zu ihren Eingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Diese Aufgabe definiert die folgenden Ausgabevariablen, die Sie in Downstreamschritten, Aufträgen und Phasen verwenden können.

JENKINS_JOB_ID
Die ID des Jenkins-Auftrags instance von dieser Aufgabe in die Warteschlange gestellt. Verwenden Sie diese Variable im Jenkins-Task "Artefakte herunterladen", um die Artefakte für diesen bestimmten Auftrag instance herunterzuladen.

Hinweise

Verwenden Sie diese Aufgabe, um einen Auftrag auf einem Jenkins-Server in die Warteschlange zu stellen.

Team Foundation Server-Plug-In

Sie können das Team Foundation Server-Plug-In (Version 5.2.0 oder höher) verwenden, um Dateien automatisch aus dem Jenkins-Arbeitsbereich zu sammeln und in den Build herunterzuladen.

So richten Sie ihn ein:

1. Installieren Sie das Team Foundation Server-Plug-In auf dem Jenkins-Server.

2. Fügen Sie auf dem Jenkins-Server für jeden Auftrag, aus dem Sie Ergebnisse sammeln möchten, die Aktion Ergebnisse für Azure Pipelines/TFS nach dem Build sammeln hinzu, und konfigurieren Sie sie dann mit einem oder mehreren Paaren des Ergebnistyps und des Einschließendateimusters.

3. Auf dem Jenkins-Warteschlangenauftrag aktivieren Sie den Buildtask die Ausgabe der Erfassungskonsole, und warten Sie auf den Abschluss , um Ergebnisse aus dem Auftrag auf Stammebene zu sammeln, oder die Ausgabe der Capture-Pipeline, und warten Sie, bis die Pipeline abgeschlossen ist , um Ergebnisse aus allen Pipelineaufträgen zu sammeln.

Die Ergebnisse werden in $(Build.StagingDirectory)/jenkinsResults/Auftragsname/team-results.zip heruntergeladen und an diesen Speicherort extrahiert. Jeder Satz von Ergebnistypen, die vom Plug-In gesammelt werden, befindet sich unter dem Teamergebnisseverzeichnis $(Build.StagingDirectory)/jenkinsResults/Auftragsname/team-results/ResultType/. Dies ist das Verzeichnis, in dem Buildergebnisse von downstream-Aufgaben veröffentlicht werden können (z. B. Testergebnisse veröffentlichen und Code Coverage-Ergebnisse veröffentlichen).

Anforderungen

Anforderung	BESCHREIBUNG
Pipelinetypen	YAML, Klassischer Build, klassisches Release
Wird ausgeführt auf	Agent, DeploymentGroup
Forderungen	Keine
Capabilities	Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen	Any
Setzbare Variablen	Any
Agent-Version	2.144.0 oder höher
Aufgabenkategorie	Entwickeln