JenkinsQueueJob@2 – Jenkins-Warteschlangenauftrag v2-Aufgabe
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.
# 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.
Eingänge
serverEndpoint
-
Jenkins-Serviceverbindung
string
. Erforderlich.
Gibt die Dienstverbindung für Ihre Jenkins-Instanz an. Klicken Sie auf den Link "Verwalten", um eine neue Jenkins-Dienstverbindung zu erstellen.
jobName
-
Auftragsname
string
. Erforderlich.
Der Name des zu warteschlangenden Jenkins-Auftrags. Dies muss genau mit dem Auftragsnamen auf dem Jenkins-Server übereinstimmen.
isMultibranchJob
-
Auftrag ist vom Typ "Multibranch-Pipeline"
boolean
. Standardwert: false
.
Dieser Auftrag ist eine Mehrbranchpipeline. Wenn angegeben, fügen Sie den entsprechenden Verzweigungsnamen hinzu. Für diese Eingabe ist das Team Foundation Server-Plug-In für Jenkins v5.3.4 oder höher erforderlich.
multibranchPipelineBranch
-
Multibranch-Pipeline-
string
. Erforderlich, wenn isMultibranchJob = true
.
Stellt diesen Verzweigungspipelineauftrag mit mehreren Warteschlangen 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 den Abschluss
boolean
. Standardwert: true
.
Wenn angegeben, erfasst diese Eingabe die Ausgabe der Jenkins-Buildkonsole, wartet auf den Abschluss des Jenkins-Builds und erfolgreich/schlägt basierend auf dem Jenkins-Buildergebnis fehl. Andernfalls wird diese Aufgabe nach der Warteschlange des Jenkins-Auftrags erfolgreich abgeschlossen, ohne auf die Ausführung des Jenkins-Builds zu warten.
capturePipeline
-
Erfassen der Pipelineausgabe und Warten auf den Pipelineabschluss
boolean
. Wahlfrei. Wird verwendet, wenn captureConsole = true
. Standardwert: true
.
Wenn angegeben, erfasst diese Aufgabe die vollständige Ausgabe der Jenkins-Buildpipeline-Konsole, wartet auf den Abschluss der vollständigen Jenkins-Buildpipeline und erfolgreich/schlägt basierend auf dem Buildpipelineergebnis von Jenkins fehl. Andernfalls wird diese Aufgabe nach Abschluss des ersten Jenkins-Auftrags erfolgreich abgeschlossen, ohne auf die Ausführung der vollständigen Jenkins-Buildpipeline zu warten.
isParameterizedJob
-
Parametrisierten Auftrag
Eingabealias: parameterizedJob
.
boolean
. Standardwert: false
.
Gibt an, ob der Jenkins-Auftrag Parameter akzeptiert. Verwenden Sie diese Eingabe, auch wenn alle Standardparameterwerte verwendet werden und keine Parameter tatsächlich angegeben werden.
jobParameters
-
Auftragsparameter
string
. Wahlfrei. Wird verwendet, wenn parameterizedJob = true
.
Gibt Auftragsparameter mit einer pro Zeile im Format <parameterName>=<parameterValue>
an.
Wenn Sie einen Parameter auf einen leeren Wert festlegen möchten, der zum Überschreiben eines Standardwerts nützlich ist, lassen Sie den Parameterwert aus. Geben Sie z. B. parameterName=
an.
Variablen werden unterstützt. Um einen commitId
Parameterwert auf die Git-Commit-ID des Builds festzulegen, können Sie z. B. 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 bei instabilen Ergebnissen
boolean
. Standardwert: false
.
Gibt die Strenge einer Erfolgsdefinition an oder gibt an, ob eine Instabilität als Fehler betrachtet werden soll. Der false
Wert gilt für eine nicht strenge Version, und die true
gilt für eine strenge Version. Bei Festlegung auf true
wird ein instabiles Buildergebnis als Fehler behandelt. Andernfalls wird ein instabiles Ergebnis als Erfolg behandelt.
retryCount
-
Anzahl der Wiederholungen für fehlgeschlagene Verbindung
string
. Standardwert: 3
.
Gibt die Anzahl der Verbindungsversuche an, wenn Verbindungsfehler oder -fehler auftreten.
delayBetweenRetries
-
Zeit zwischen Wiederholungen
string
. Standardwert: 60
.
Gibt die Zeitspanne zwischen Verbindungsversuchen an, wenn ein Fehler auftritt. Der Wert wird in Sekunden angegeben.
Aufgabensteuerungsoptionen
Alle Aufgaben verfügen zusätzlich zu ihren Aufgabeneingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerelementoptionen und allgemeinen Aufgabeneigenschaften.
Ausgabevariablen
Mit dieser Aufgabe werden die folgenden Ausgabevariablendefiniert, die Sie in nachgeschalteten Schritten, Aufträgen und Phasen verwenden können.
JENKINS_JOB_ID
Die ID der Von dieser Aufgabe in die Warteschlange gestellten Jenkins-Auftragsinstanz. Verwenden Sie diese Variable in der Aufgabe "Jenkins Download Artifacts", um die Artefakte für diese bestimmte Auftragsinstanz herunterzuladen.
Bemerkungen
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 sie in den Build herunterzuladen.
So richten Sie es ein:
Installieren Sie das Team Foundation Server-Plug-In- auf dem Jenkins-Server.
Fügen Sie auf dem Jenkins-Server für jeden Auftrag, aus dem Sie Ergebnisse sammeln möchten, die "Ergebnisse für Azure Pipelines/TFS sammeln" Nachbuildaktion hinzu, und konfigurieren Sie ihn dann mit einem oder mehreren Ergebnistyppaaren und schließen sie ein Dateimuster ein.
Im Jenkins-Warteschlangenauftrag aktivieren Sie die Erfassungskonsolenausgabe, und warten Sie auf den Abschluss, um Ergebnisse aus dem Auftrag der Stammebene zu sammeln, oder die Erfassen der Pipelineausgabe und warten Sie auf den Pipelineabschluss, um Ergebnisse aus allen Pipelineaufträgen zu sammeln.
Die Ergebnisse werden in das $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results.zip heruntergeladen und an diesen Speicherort extrahiert. Jeder Satz von Ergebnistypen, die vom Plug-In gesammelt werden, befindet sich unter dem Teamergebnisverzeichnis, $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results/ResultType/. Dies ist das Verzeichnis, in dem Buildergebnisse von nachgelagerten Aufgaben veröffentlicht werden können (z. B. Veröffentlichen von Testergebnissen und Veröffentlichen von Codeabdeckungsergebnissen).
Anforderungen
Anforderung | BESCHREIBUNG |
---|---|
Pipelinetypen | YAML, Classic Build, Classic Release |
Läuft auf | Agent, DeploymentGroup |
Anforderungen | Nichts |
Funktionen | Dieser Vorgang erfüllt keine Anforderungen für nachfolgende Vorgänge im Auftrag. |
Befehlseinschränkungen | Jegliche |
Settable-Variablen | Jegliche |
Agentversion | 2.144.0 oder höher |
Vorgangskategorie | Bauen |
Anforderung | BESCHREIBUNG |
---|---|
Pipelinetypen | YAML, Classic Build, Classic Release |
Läuft auf | Agent, DeploymentGroup |
Anforderungen | Nichts |
Funktionen | Dieser Vorgang erfüllt keine Anforderungen für nachfolgende Vorgänge im Auftrag. |
Befehlseinschränkungen | Jegliche |
Settable-Variablen | Jegliche |
Agentversion | Alle unterstützten Agentversionen. |
Vorgangskategorie | Bauen |