JenkinsQueueJob@1 – Jenkins Queue Job v1-Aufgabe

Artikel
07/02/2024

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

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.

Eingaben

serverEndpoint - Jenkins-Dienstendpunkt
string. Erforderlich.

Gibt den Dienstendpunkt für Ihre Jenkins-instance an. Klicken Sie auf den Link Verwalten (wenn Sie die Aufgabe Assistent verwenden), um einen neuen Jenkins-Dienstendpunkt 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. Fügen Sie bei Angabe 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 - Pipelineverzweigung mit mehreren Dreibranchs
string. Erforderlich, wenn isMultibranchJob = true.

Stellt diesen Mehrbranch-Pipelineauftrag für den angegebenen Branch in die Warteschlange. 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 die Fertigstellung
boolean. Standardwert. true.

Wenn 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/fehl. Andernfalls wird dieser Schritt erfolgreich abgeschlossen, nachdem 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 diese Eingabe die vollständige Ausgabe der Jenkins-Buildpipeline, wartet, bis die vollständige Jenkins-Buildpipeline abgeschlossen ist, und schlägt basierend auf dem Ergebnis der Jenkins-Buildpipeline erfolgreich/fehl. Andernfalls wird diese Eingabe nach Abschluss des ersten Jenkins-Auftrags erfolgreich abgeschlossen, ohne darauf zu warten, dass die vollständige Jenkins-Buildpipeline ausgeführt wird.

parameterizedJob - Parametrisierter Auftrag
boolean. Standardwert. false.

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

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

Gibt Auftragsparameter mit einem pro Zeile an, z. B.: <parameterName>=<parameterValue>.

Wenn Sie einen Parameter auf einen leeren Wert festlegen möchten, 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

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

Keine.

Anforderungen

Anforderung	BESCHREIBUNG
Pipelinetypen	YAML, Klassischer Build, klassische Version
Wird ausgeführt auf	Agent, DeploymentGroup
Forderungen	Keine
Capabilities	Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen	Any
Einstellbare Variablen	Any
Agent-Version	Alle unterstützten Agent-Versionen.
Aufgabenkategorie	Entwickeln

Freigeben über