Přidání fází, závislostí a podmínek

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Fáze je logická hranice v pipeline Azure DevOps. Fáze se dají použít k seskupení akcí v procesu vývoje softwaru (například sestavení aplikace, spuštění testů, nasazení do předprodukčního prostředí). Každá fáze obsahuje jednu nebo více úloh.

Když v pipelině definujete více fází, spustí se ve výchozím nastavení jedna po druhé. Fáze můžou záviset také na sobě. Pomocí klíčového dependsOn slova můžete definovat závislosti. Fáze se můžou spouštět také na základě výsledku předchozí fáze s podmínkami.

Informace o tom, jak fáze fungují s paralelními úlohami a licencováním, najdete v tématu Konfigurace a platba za paralelní úlohy.

Pro informace o tom, jak fáze souvisejí s jinými částmi dataového toku, jako jsou úlohy, se podívejte na Klíčové koncepty dataových toků.

Další informace o tom, jak fáze souvisejí s částmi kanálu, najdete v článku fáze schématu YAML.

YAML

Úlohy potrubí můžete uspořádat do fází. Fáze jsou hlavními částmi v rámci pipeline: sestavení této aplikace, spuštění těchto testů a nasazení do předprodukce jsou dobrými příklady těchto fází. Jedná se o logické hranice ve vašem kanálu, kde můžete kanál pozastavit a provádět různé kontroly.

Každý kanál má alespoň jednu fázi, i když ho explicitně nedefinujete. Fáze můžete také uspořádat do grafu závislostí tak, aby se jedna fáze spustila před druhou. Pro určitou fázi platí limit 256 úloh.

Klasické

Uspořádejte úlohy pro nasazení ve vašem vydávacím procesu do fází. Fáze jsou hlavní části v kanálu vydání: spouštění funkčních testů, nasazení do předprodukce a nasazení do produkce jsou dobrými příklady fází vydání.

Fáze ve vydávacím kanálu se skládá z pracovních úloh a úkolů.

Schválení a brány, podmínky nasazení a triggery a zásady front určují, kdy se verze nasazuje do fáze.

Určení fází

YAML

V nejjednodušším případě nepotřebujete v kanálu žádné logické hranice. V takovém případě nemusíte klíčové slovo explicitně používat stage . Úlohy můžete přímo zadat v souboru YAML.

# this has one implicit stage and one implicit job
pool:
  vmImage: 'ubuntu-latest'
steps:
- bash: echo "Hello world"

# this pipeline has one implicit stage
jobs:
- job: A
  steps:
  - bash: echo "A"

- job: B
  steps:
  - bash: echo "B"

Pokud uspořádáte své potrubí do několika fází, použijete klíčové slovo stages.

stages:
- stage: A
  jobs:
  - job: A1
  - job: A2

- stage: B
  jobs:
  - job: B1
  - job: B2

Pokud zadáte pool na úrovni fáze, pak všechny úlohy definované v této fázi používají tento fond, pokud není specifikován na úrovni úlohy.

stages:
- stage: A
  pool: StageAPool
  jobs:
  - job: A1 # will run on "StageAPool" pool based on the pool defined on the stage
  - job: A2 # will run on "JobPool" pool
    pool: JobPool

Úplná syntaxe pro určení fáze je:

stages:
- stage: string  # name of the stage, A-Z, a-z, 0-9, and underscore
  displayName: string  # friendly name to display in the UI
  dependsOn: string | [ string ]
  condition: string
  pool: string | pool
  variables: { string: string } | [ variable | variableReference ] 
  jobs: [ job | templateReference]

Klasické

Pokud chcete do vydávacího kanálu přidat fázi, vyberte vydávací kanál na stránce Vydané verze, vyberte akci pro její úpravu, a potom vyberte záložku Kanál. I když nejdůležitější součástí definování fáze jsou úlohy automatizace, můžete také nakonfigurovat několik vlastností a možností pro fázi ve vydávacím kanálu. Můžete:

• V případě potřeby upravte název fáze.
• Určete jednoho uživatele nebo skupinu, které mají být vlastníkem fáze. Majitelé etapy dostanou upozornění při každém selhání nasazení do této etapy. Být vlastníkem jeviště automaticky neznamená mít nějaká oprávnění.
• Odstraňte fázi z potrubí.
• Změňte pořadí fází.
• Uložte kopii fáze jako šablonu fáze.
• Umožňuje spravovat nastavení zabezpečení pro fázi.

Určení závislostí

YAML

Když v pipelinu definujete více fází, ve výchozím nastavení se spustí postupně v pořadí, ve kterém je definujete v souboru YAML. Výjimkou je přidání závislostí. V případě závislostí se fáze spouští podle pořadí dependsOn požadavků.

Kanály musí obsahovat alespoň jednu fázi bez závislostí.

Syntaxe pro definování více fází a jejich závislostí je:

stages:
- stage: string
  dependsOn: string
  condition: string

Ukázkové fáze, které se spouštějí postupně:

# if you do not use a dependsOn keyword, stages run in the order they are defined
stages:
- stage: QA
  jobs:
  - job:
    ...

- stage: Prod
  jobs:
  - job:
    ...

Ukázkové fáze, které běží paralelně:

stages:
- stage: FunctionalTest
  jobs:
  - job:
    ...

- stage: AcceptanceTest
  dependsOn: []    # this removes the implicit dependency on previous stage and causes this to run in parallel
  jobs:
  - job:
    ...

Příklad rozvětvení a sběhu:

stages:
- stage: Test

- stage: DeployUS1
  dependsOn: Test    # this stage runs after Test

- stage: DeployUS2
  dependsOn: Test    # this stage runs in parallel with DeployUS1, after Test

- stage: DeployEurope
  dependsOn:         # this stage runs after DeployUS1 and DeployUS2
  - DeployUS1
  - DeployUS2

Klasické

Závislosti řídíte nastavením spouštěčů v jednotlivých fázích vydávacího kanálu.

• Fáze se spouštějí pomocí spouštěče nebo ručně.
• S aktivační událostí Po vydání se fáze spustí hned po spuštění vydané verze paralelně s dalšími fázemi, které mají aktivační událost Po vydání .
• Po spuštění po fázi začne fáze poté, co se dokončí všechny závislé fáze. Pomocí tohoto můžete modelovat chování rozdělení a sloučení pro jednotlivé fáze.

Definování podmínek

Můžete určit podmínky, za kterých se jednotlivé fáze spouštějí pomocí výrazů. Ve výchozím nastavení se fáze spustí, pokud nezávisí na žádné jiné fázi, nebo pokud byly všechny fáze, na kterých závisí, úspěšně dokončeny. Toto chování můžete přizpůsobit vynucením spuštění fáze, i když předchozí fáze selže nebo zadáte vlastní podmínku.

Pokud upravíte výchozí podmínku pro fázi v předchozích krocích, odstraníte podmínky pro jejich dokončení a úspěšné splnění. Pokud tedy používáte vlastní podmínku, je běžné zkontrolovat and(succeeded(),custom_condition) , jestli se předchozí fáze úspěšně spustila. V opačném případě se fáze spustí bez ohledu na výsledek předchozí fáze.

Poznámka:

Podmínky pro selhání ('JOBNAME/STAGENAME') a úspěch ('JOBNAME/STAGENAME'), jak je znázorněno v následujícím příkladu, fungují pouze pro YAML kanály.

YAML

Příklad spuštění fáze na základě stavu spuštění předchozí fáze:

stages:
- stage: A

# stage B runs if A fails
- stage: B
  condition: failed()

# stage C runs if B succeeds
- stage: C
  dependsOn:
  - A
  - B
  condition: succeeded('B')

Příklad použití vlastní podmínky:

stages:
- stage: A

- stage: B
  condition: and(succeeded(), eq(variables['build.sourceBranch'], 'refs/heads/main'))

Klasické

Když zadáte triggery Po vydání nebo Po fázi , můžete také určit filtry větví pro artefakty spotřebované ve vydané verzi. Nasazení bude probíhat do fáze, pouze pokud jsou splněny filtry větví.

Zadání zásad řízení front

YAML

Kanály YAML nepodporují zásady frontování. Každé spuštění kanálu je nezávislé a neví o ostatních spuštěních. Jinými slovy, vaše dva po sobě jdoucí commity mohou aktivovat dvě pipeline, přičemž obě tyto pipeline budou provádět stejnou sekvenci fází, aniž by na sebe čekaly. Zatímco pracujeme na zavedení front ve kanálech YAML, doporučujeme použít ruční schvalování, abyste mohli řídit pořadí provádění ručně, pokud je to důležité.

Klasické

V některých případech můžete být schopni vygenerovat buildy rychleji, než je možné je nasadit. Alternativně můžete nakonfigurovat více agentů a například vytvářet vydání ze stejného vydavatelského kanálu pro nasazení různých artefaktů. V takových případech je užitečné mít možnost řídit, jak se více verzí softwaru zařadí do fronty do fáze. Zásady řízení front vám dávají kontrolu.

Možnosti, které můžete zvolit pro zásady řízení front, jsou:

• Počet paralelních nasazení: Tuto možnost použijte, pokud dynamicky zřídíte nové prostředky ve vaší fázi a fyzicky dokážete paralelně zpracovat nasazení více verzí, ale chcete omezit počet paralelních nasazení.

• Pokud zadáte maximální počet nasazení, zobrazí se dvě další možnosti:

  • Nasadit vše v posloupnosti: Tuto možnost použijte, pokud chcete nasadit všechny vydané verze postupně do stejných sdílených fyzických prostředků. Nasazením sestavení postupně jeden za druhým zajistíte, že dvě úlohy nasazení nebudou cílit na stejné fyzické prostředky současně, i když je k dispozici více agentů sestavení a verzí. Také se ujistěte, že žádosti o schválení před nasazením pro fázi jsou odesílány postupně.

  • Nasaďte nejnovější a zrušte ostatní: Tuto možnost použijte, pokud vytváříte buildy rychleji než vydané verze a chcete nasadit jenom nejnovější build.

Abyste pochopili, jak tyto možnosti fungují, zvažte scénář, ve kterém se rychle vytvoří vydání R1, R2, ..., R5 jednoho vydávacího kanálu. Předpokládejme, že první fáze tohoto pipeline se nazývá QA a má definované schvalovatele před nasazením i po nasazení.

• Pokud nezadáte limit počtu paralelních nasazení, odešle se všech pět žádostí o schválení hned po vytvoření verzí. Pokud schvalovatelé schválí všechny verze, všechny budou nasazeny paralelně do fáze kontroly kvality. (pokud Fáze kontroly kvality neměla definované žádné schvalovatele předběžného nasazení, všech pět verzí se automaticky nasadí paralelně s touto fází).

• Pokud zadáte limit a nasadíte vše v posloupnosti a limit už byl dosažen, bude nejprve odesláno schválení předběžného nasazení pro verzi R1 . Po dokončení tohoto schválení se zahájí nasazení verze R1 do fáze kontroly kvality . Dále se odešle žádost o schválení po nasazení pro verzi R1. Teprve po dokončení tohoto schválení po nasazení se zahájí spuštění verze R2 a jeho schválení předběžného nasazení se odešle. Tento proces pokračuje i pro všechny vydané verze.

• Pokud zadáte limit a nasadíte nejnovější a zrušíte ostatní a už bylo dosaženo limitu, verze R2, R3 a R4 se přeskočí a schválení předběžného nasazení pro R5 ve fázi kontroly kvality se odešle okamžitě po dokončení schválení verze R1 po nasazení.

Určete schválení

YAML

Pomocí kontrol schválení můžete ručně řídit, kdy se má fáze spustit. To se běžně používá k řízení nasazení do produkčních prostředí. Kontroly jsou mechanismus, který je k dispozici vlastníku prostředku, aby řídil, zda a kdy fáze v potrubí může prostředek využívat. Jako vlastník prostředku, jako je například prostředí, můžete definovat kontroly, které musí být splněny před tím, než může začít fáze, která daný prostředek využívá.

V současné době jsou v prostředích podporovány kontroly ručního schvalování. Další informace najdete v tématu Schválení.

Klasické

Ruční schválení můžete přidat na začátku nebo na konci každé fáze potrubí. Další informace najdete v tématu Přehled schválení a bran vydání.

Přidat ruční spouštěč

Ručně spouštěné fáze potrubí YAML umožňují mít sjednocené potrubí, aniž by bylo nutné ho vždy dokončit.

Kanál může například zahrnovat fáze sestavení, testování, nasazení do přípravného prostředí a nasazení do produkčního prostředí. Můžete chtít, aby se všechny fáze spouštěly automaticky s výjimkou produkčního nasazení, které chcete aktivovat ručně, až budete připraveni.

Chcete-li tuto funkci použít, přidejte vlastnost trigger: manual ke fázi.

V následujícím příkladu se fáze vývoje spustí automaticky, zatímco produkční fáze vyžaduje ruční aktivaci. Obě fáze spouští výstupní skript Hello World.

stages:
- stage: development
  displayName: Deploy to development
  jobs:
  - job: DeployJob
    steps:
    - script: echo 'hello, world'
      displayName: 'Run script'
- stage: production
  displayName: Deploy to production
  trigger: manual
  jobs:
  - job: DeployJob
    steps:
    - script: echo 'hello, world'
      displayName: 'Run script'

Označení fáze jako nepřeskočitelné

Označte fázi jako isSkippable: false, abyste zabránili uživatelům kanálu ve vynechání fází. Můžete mít například šablonu YAML, která vloží fázi, která provádí detekci malwaru ve všech kanálech. Pokud nastavíte isSkippable: false pro tuto fázi, pipeline nebude moct přeskočit detekci malwaru.

V následujícím příkladu je fáze detekce malwaru označena jako nepřeskočitelná, což znamená, že se musí spustit jako součást běhu pipeline.

- stage: malware_detection
  displayName: Malware detection
  isSkippable: false
  jobs:
  - job: check_job
    ...

Pokud je fáze nepřeskočitelná, zobrazí se v konfiguračním panelu Fáze ke spuštění s neaktivním zaškrtávacím políčkem.