Referenční informace ke schématu YAML pro Azure Pipelines

Referenční informace ke schématu YAML pro Azure Pipelines jsou podrobné referenční informace pro kanály YAML, které uvádějí všechny podporované syntaxe YAML a jejich dostupné možnosti.

Pokud chcete vytvořit kanál YAML, začněte definicí kanálu . Další informace o vytváření kanálů YAML naleznete v tématu Přizpůsobení kanálu.

Referenční informace ke schématu YAML nepokrývá úlohy. Další informace o úkolech najdete v indexu úloh Azure Pipelines.

Definice

kanálu
kanál je jedna nebo více fází, které popisují proces CI/CD. Definice kanálu obsahuje dokumentaci pro vlastnosti kořenové úrovně, jako je name.

rozšiřuje
Rozšíří kanál pomocí šablony.

úloh
Určuje úlohy, které tvoří práci fáze.

jobs.deployment
úloha nasazení je speciální typ úlohy. Jedná se o kolekci kroků, které se mají spouštět postupně v prostředí.

jobs.deployment.environment
název cílového prostředí a volitelně název prostředku pro zaznamenání historie nasazení; format: environment-name.resource-name.

jobs.deployment.strategy
strategie provádění pro toto nasazení.

jobs.deployment.strategy.canary
strategie nasazení Canary Deployment.

jobs.deployment.strategy.rolling
strategie postupného nasazení.

jobs.deployment.strategy.runOnce
strategii nasazení RunOnce.

jobs.job
úloha A je kolekce kroků spuštěných agentem nebo na serveru.

jobs.job.container
název prostředku kontejneru.

jobs.job.strategy
strategie provádění pro tuto úlohu.

jobs.job.uses
Všechny prostředky vyžadované touto úlohou, na které se již neodkazují.

jobs.template
sada úloh definovaných v šabloně.

parametrů
Určuje parametry modulu runtime předané kanálu.

parameters.parameter
parametry šablony kanálu.

fondu
Který fond se má použít pro úlohu kanálu.

pool.demands
požadavky (pro soukromý fond).

pr
trigger žádosti o přijetí změn.

prostředků
Prostředky určují sestavení, úložiště, kanály a další prostředky používané kanálem.

resources.builds
Seznam prostředků sestavení odkazovaných kanálem.

resources.builds.build
prostředek sestavení sloužící k odkazu na artefakty ze spuštění.

resources.containers
Seznam imagí kontejneru.

resources.containers.container
prostředek kontejneru použitý k odkaz na image kontejneru.

resources.containers.container.trigger
Zadejte žádné, které chcete zakázat, true pro aktivaci u všech značek obrázků nebo použijte úplnou syntaxi, jak je popsáno v následujících příkladech.

resources.packages
Seznam prostředků balíčku

resources.packages.package
prostředek balíčku použitý k odkazování na balíček NuGet nebo npm GitHub.

resources.pipelines
seznam prostředků kanálu.

resources.pipelines.pipeline
prostředek kanálu.

resources.pipelines.pipeline.trigger
Zadejte žádné, které chcete zakázat, hodnotu true, pokud chcete zahrnout všechny větve, nebo použijte úplnou syntaxi, jak je popsáno v následujících příkladech.

resources.pipelines.pipeline.trigger.branches
větve, které se mají zahrnout nebo vyloučit pro aktivaci spuštění.

resources.repositories
Seznam prostředků úložiště.

resources.repositories.repository
prostředek úložiště A slouží k odkazování na další úložiště ve vašem kanálu.

resources.webhooks
Seznam webhooků

resources.webhooks.webhook
prostředek webhooku umožňuje integrovat kanál s externí službou pro automatizaci pracovního postupu.

resources.webhooks.webhook.filters
Seznam filtrů aktivačních událostí.

resources.webhooks.webhooks.webhook.filters.filter
filtru triggeru prostředku Webhooku.

plány
Seznam plánů určuje naplánované aktivační události pro kanál.

schedules.cron
Naplánovaná aktivační událost určuje plán, podle kterého se vytvářejí větve.

fáze
dílčí fáze jsou kolekcí souvisejících úloh.

stages.stage
fáze A je kolekce souvisejících úloh.

stages.template
Můžete definovat sadu fází v jednom souboru a použít ji vícekrát v jiných souborech.

kroky
Kroky jsou lineární posloupností operací, které tvoří úlohu.

steps.bash
Spustí skript v prostředí Bash ve Windows, macOS a Linuxu.

steps.checkout
Konfigurace způsobu, jakým kanál kontroluje zdrojový kód.

steps.download
artefakty ke stažení přidružené k aktuálnímu spuštění nebo z jiného kanálu Azure, který je přidružený jako prostředek kanálu.

steps.downloadBuild
stahuje artefakty sestavení.

steps.getPackage
stáhne balíček z informačního kanálu pro správu balíčků v Azure Artifacts nebo Azure DevOps Serveru.

steps.powershell
Spustí skript pomocí Windows PowerShellu (ve Windows) nebo pwsh (Linux a macOS).

steps.publish
Publikuje (nahraje) soubor nebo složku jako artefakt kanálu, který můžou využívat jiné úlohy a kanály.

steps.pwsh
Spustí skript v PowerShellu Core ve Windows, macOS a Linuxu.

steps.reviewApp
Stažené soubory vytvoří prostředek dynamicky pod poskytovatelem fáze nasazení.

steps.script
Spustí skript pomocí cmd.exe ve Windows a Bash na jiných platformách.

steps.task
Spustí úlohu.

steps.template
Definujte sadu kroků v jednom souboru a použijte ji vícekrát v jiném souboru.

cílových
Úlohy se spouští v kontextu spuštění, což je hostitel agenta nebo kontejner.

target.settableVariables
Omezení, pro které proměnné lze nastavit.

trigger
trigger kontinuální integrace (push).

proměnných
Definujte proměnné pomocí párů name/value.

variables.group
Odkazovat proměnné ze skupiny proměnných.

variables.name
Definujte proměnné pomocí názvu a úplné syntaxe.

variables.template
Definování proměnných v šabloně

Podpůrné definice

Poznámka:

Podpůrné definice nejsou určeny pro použití přímo v kanálu. Podpůrné definice se používají pouze jako součást jiných definic a jsou zde zahrnuty pro referenci.

deployHook
Slouží ke spuštění kroků, které nasazují vaši aplikaci.

includeExcludeFilters
Seznamy položek, které chcete zahrnout nebo vyloučit.

includeExcludeStringFilters
položky, které chcete zahrnout nebo vyloučit.

mountReadOnly
svazky pro připojení jen pro čtení, výchozí hodnota je všechna false.

onFailureHook
Slouží ke spuštění kroků pro akce vrácení zpět nebo vyčištění.

onSuccessHook
Slouží ke spuštění kroků pro akce vrácení zpět nebo vyčištění.

onSuccessOrFailureHook
Slouží ke spuštění kroků pro akce vrácení zpět nebo vyčištění.

postRouteTrafficHook
Slouží ke spuštění kroků po směrování provozu. Tyto úlohy obvykle monitorují stav aktualizované verze pro definovaný interval.

preDeployHook
Slouží ke spuštění kroků, které inicializují prostředky před spuštěním nasazení aplikace.

routeTrafficHook
Slouží ke spuštění kroků, které obsluhují provoz do aktualizované verze.

pracovního prostoru
možnosti pracovního prostoru agenta.

Konvence dokumentace schématu YAML

Referenční příručka ke schématu YAML je podrobný referenční průvodce kanály YAML služby Azure Pipelines. Obsahuje katalog všech podporovaných funkcí YAML a dostupných možností.

Tady jsou zásady syntaxe používané v odkazu na schéma YAML.

• Vlevo od : je literálové klíčové slovo používané v definicích kanálu.
• Napravo od : je datový typ. Datový typ může být primitivní typ, například řetězec nebo odkaz na bohatou strukturu definovanou jinde v tomto odkazu.
• Zápis [datového typu] označuje pole uvedeného typu definice. Například [ string ] je pole řetězců.
• Zápis {datový typ:datový typ} označuje mapování jednoho datového typu na jiný. Například { string: string } je mapování řetězců na řetězce.
• Symbol | označuje, že pro klíčové slovo je k dispozici více datových typů. Například job | template znamená, že je povolena definice úlohy nebo odkaz na šablonu.

Viz také

Tento odkaz popisuje schéma souboru YAML služby Azure Pipelines. Základní informace o YAML najdete v tématu Learn YAML vY Minutes . Azure Pipelines nepodporuje všechny funkce YAML. Mezi nepodporované funkce patří ukotvení, složité klíče a sady. Na rozdíl od standardního YAML závisí Azure Pipelines na zobrazení stage, job, tasknebo zástupce úlohy, jako je script jako první klíč v mapování.