JenkinsQueueJob@2 – úloha fronty Jenkinse v2
Pomocí této úlohy můžete úlohu zařadit do fronty na serveru 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.
# 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.
# 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.
Vstupy
serverEndpoint
- Připojení služby Jenkins
string
. Povinná hodnota.
Určuje připojení služby pro vaši instanci Jenkinse. Kliknutím na odkaz Spravovat vytvořte nové připojení služby Jenkins.
jobName
- Název úlohy
string
. Povinná hodnota.
Název úlohy Jenkinse do fronty. Musí přesně odpovídat názvu úlohy na serveru Jenkins.
isMultibranchJob
- Úloha je typu víceoborového kanálu.
boolean
. Výchozí hodnota: false
.
Tato úloha je víceoborový kanál. Pokud je zadaný, přidejte příslušný název větve. Tento vstup vyžaduje modul plug-in Team Foundation Serveru pro Jenkins v5.3.4 nebo novější.
multibranchPipelineBranch
- Větev kanálu Multibranch
string
. Vyžaduje se, když isMultibranchJob = true
.
Zařadí tuto úlohu kanálu s více větvemi do fronty v zadané větvi. Tento vstup vyžaduje modul plug-in Team Foundation Serveru pro Jenkins v5.3.4 nebo novější.
captureConsole
- Záznam výstupu konzoly a čekání na dokončení
boolean
. Výchozí hodnota: true
.
Pokud je zadaný, tento vstup zaznamená výstup konzoly sestavení Jenkinse, počká na dokončení sestavení Jenkinse a na základě výsledku sestavení Jenkinse dojde k úspěšnému/selhání. V opačném případě se úloha Jenkinse ve frontě úspěšně dokončí bez čekání na spuštění sestavení Jenkinse.
capturePipeline
- Zachytávání výstupu kanálu a čekání na dokončení kanálu
boolean
. Nepovinný parametr. Použijte, když captureConsole = true
. Výchozí hodnota: true
.
Pokud je zadáno, tato úloha zaznamená úplný výstup konzoly kanálu sestavení Jenkinse, počká na dokončení úplného kanálu sestavení Jenkinse a na základě výsledku kanálu sestavení Jenkinse dojde k úspěchu nebo selhání. V opačném případě se po dokončení první úlohy Jenkinse tato úloha úspěšně dokončí bez čekání na spuštění úplného kanálu sestavení Jenkinse.
isParameterizedJob
- Parametrizovaná úloha
Alias vstupu: parameterizedJob
. boolean
. Výchozí hodnota: false
.
Určuje, jestli úloha Jenkinse přijímá parametry. Tento vstup použijte i v případě, že jsou použity všechny výchozí hodnoty parametrů a nejsou ve skutečnosti zadány žádné parametry.
jobParameters
- Parametry úlohy
string
. Nepovinný parametr. Použijte, když parameterizedJob = true
.
Určuje parametry úlohy s jedním na řádek ve formátu <parameterName>=<parameterValue>
.
Pokud chcete nastavit parametr na prázdnou hodnotu, což je užitečné pro přepsání výchozí hodnoty, hodnotu parametru ponechte. Zadejte parameterName=
například .
Podporují se proměnné. Pokud chcete například nastavit commitId
hodnotu parametru na ID potvrzení Gitu sestavení, můžete použít: commitId=$(Build.SourceVersion)
. Další informace najdete v dokumentaci k proměnným.
Podporované typy parametrů Jenkinse jsou:
Boolean
Choice
Password
String
failOnUnstableResult
- Selhání při nestabilním výsledku
boolean
. Výchozí hodnota: false
.
Určuje striktní definici úspěchu nebo jestli se má nestabilní považovat za selhání nebo ne. Hodnota false
je pro nestriktní verzi a true
hodnota je pro striktní verzi. Pokud je nastavená hodnota true
, nestabilní výsledek sestavení se považuje za selhání. Jinak se nestabilní výsledek považuje za úspěch.
retryCount
- Počet opakovaných pokusů o neúspěšné připojení
string
. Výchozí hodnota: 3
.
Určuje počet opakovaných pokusů o připojení, když dojde k chybě nebo selhání připojení.
delayBetweenRetries
- Čas mezi opakovanými pokusy
string
. Výchozí hodnota: 60
.
Určuje dobu mezi opakovanými pokusy o připojení, když dojde k chybě. Tato hodnota se zadává v sekundách.
Možnosti ovládání úloh
Všechny úlohy mají kromě vstupů také možnosti ovládání. Další informace najdete v tématu Možnosti ovládacích prvků a běžné vlastnosti úlohy.
Výstupní proměnné
Tato úloha definuje následující výstupní proměnné, které můžete využívat v podřízených krocích, úlohách a fázích.
JENKINS_JOB_ID
ID instance úlohy Jenkinse zařazené do fronty touto úlohou. Tuto proměnnou použijte v úloze Jenkins Download Artifacts ke stažení artefaktů pro tuto konkrétní instanci úlohy.
Poznámky
Pomocí této úlohy můžete úlohu zařadit do fronty na serveru Jenkins.
Team Foundation Server Plug-in
Pomocí modulu plug-in Team Foundation Serveru (verze 5.2.0 nebo novější) můžete automaticky shromažďovat soubory z pracovního prostoru Jenkinse a stahovat je do sestavení.
Nastavení:
Nainstalujte modul plug-in Team Foundation Server na server Jenkins.
Na serveru Jenkinse pro každou úlohu, ze které chcete shromažďovat výsledky, přidejte akci Shromáždit výsledky pro Azure Pipelines/TFS po sestavení a nakonfigurujte ji pomocí jedné nebo více dvojic typu výsledku a zahrnutí vzoru souboru.
V úloze fronty Jenkinse povolte úlohu sestavení výstup konzoly Capture a počkejte na dokončení , aby se shromáždily výsledky z úlohy na úrovni kořenového adresáře nebo výstupu kanálu Capture a počkejte na dokončení kanálu , aby se shromáždily výsledky ze všech úloh kanálu.
Výsledky se stáhnou do adresáře $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results.zip a extrahují se do tohoto umístění. Každá sada typů výsledků shromažďovaných modulem plug-in bude v adresáři team-results , $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results/ResultType/. Jedná se o adresář, ve kterém můžou podřízené úkoly publikovat výsledky sestavení (například Publikovat výsledky testu a Publikovat výsledky pokrytí kódu).
Požadavky
Požadavek | Popis |
---|---|
Typy kanálů | YAML, klasický build, klasická verze |
Běží na | Agent, DeploymentGroup |
Požadavky | Žádné |
Možnosti | Tento úkol nesplňuje žádné požadavky na následné úkoly v úloze. |
Omezení příkazů | Všechny |
Nastavitelné proměnné | Všechny |
Verze agenta | 2.144.0 nebo vyšší |
Kategorie úloh | Sestavení |
Požadavek | Popis |
---|---|
Typy kanálů | YAML, classic build, verze Classic |
Spustí se | Agent, DeploymentGroup |
Požadavky | Žádné |
Možnosti | Tento úkol nesplňuje žádné požadavky na následné úkoly v úloze. |
Omezení příkazů | Všechny |
Nastavitelné proměnné | Všechny |
Verze agenta | Všechny podporované verze agenta. |
Kategorie úloh | Sestavení |