Udostępnij za pośrednictwem

Dokumentacja schematu YAML dla usługi Azure Pipelines

  • Artykuł

Dokumentacja schematu YAML dla usługi Azure Pipelines to szczegółowa dokumentacja potoków YAML zawierająca listę wszystkich obsługiwanych składni YAML i ich dostępnych opcji.

Aby utworzyć potok YAML, zacznij od definicji potoku. Aby uzyskać więcej informacji na temat tworzenia potoków YAML, zobacz Dostosowywanie potoku.

Dokumentacja schematu YAML nie obejmuje zadań. Aby uzyskać więcej informacji na temat zadań, zobacz indeks zadań usługi Azure Pipelines.

Definicje

potoku
Potok jest co najmniej jednym etapem opisujący proces ciągłej integracji/ciągłego wdrażania. Definicja potoku zawiera dokumentację właściwości poziomu głównego, takich jak name.

rozszerza
rozszerza potok przy użyciu szablonu.

zadań
Określa zadania, które składają się na pracę etapu.

jobs.deployment
Zadanie wdrożenia jest specjalnym typem zadania. Jest to zbiór kroków, które należy uruchamiać sekwencyjnie względem środowiska.

jobs.deployment.environment
nazwa środowiska docelowego i opcjonalnie nazwa zasobu do rejestrowania historii wdrożenia; format: environment-name.resource-name.

jobs.deployment.strategy
strategia wykonywania dla tego wdrożenia.

jobs.deployment.strategy.canary
strategia wdrażania kanarowego.

jobs.deployment.strategy.rolling
strategia wdrażania stopniowego.

jobs.deployment.strategy.runOnce
strategia wdrażania RunOnce.

jobs.job
Zadanie to zbiór kroków uruchamianych przez agenta lub na serwerze.

jobs.job.container
nazwa zasobu kontenera.

jobs.job.strategy
strategia wykonywania dla tego zadania.

jobs.job.uses
Wszystkie zasoby wymagane przez to zadanie, do których jeszcze nie odwołuje się odwołanie.

jobs.template
Zestaw zadań zdefiniowanych w szablonie.

parametrów
Określa parametry środowiska uruchomieniowego przekazywane do potoku.

parameters.parameter
parametry szablonu potoku.

puli
Której puli użyć dla zadania potoku.

pool.demands
Wymagania (w przypadku puli prywatnej).

pr
wyzwalacz żądania ściągnięcia.

zasobów
Zasoby określa kompilacje, repozytoria, potoki i inne zasoby używane przez potok.

resources.builds
Lista zasobów kompilacji, do których odwołuje się potok.

resources.builds.builds.build
zasób kompilacji używany do odwołowania się do artefaktów z przebiegu.

resources.containers
Lista obrazów kontenerów.

resources.containers.container
zasób kontenera używany do odwołowania się do obrazu kontenera.

resources.containers.container.trigger
Określ brak do wyłączenia, wartość true do wyzwolenia we wszystkich tagach obrazów lub użyj pełnej składni, jak opisano w poniższych przykładach.

resources.packages
lista zasobów pakietu.

resources.packages.package
zasób pakietu używany do odwołowania się do pakietu NuGet lub npm GitHub.

resources.pipelines
lista zasobów potoku.

resources.pipelines.pipeline.trigger
Określ brak do wyłączenia, wartość true do uwzględnienia wszystkich gałęzi lub użyj pełnej składni, jak opisano w poniższych przykładach.

resources.pipelines.pipeline.trigger.branches
Gałęzie do uwzględnienia lub wykluczenia w celu wyzwolenia przebiegu.

resources.repozytoria
lista zasobów repozytorium.

resources.repositoryies.repository
Zasób repozytorium służy do odwołowania się do dodatkowego repozytorium w potoku.

resources.webhooks
lista elementów webhook.

resources.webhooks.webhook
zasób elementu webhook umożliwia integrację potoku z usługą zewnętrzną w celu zautomatyzowania przepływu pracy.

resources.webhooks.webhook.filters
Lista filtrów wyzwalacza.

resources.webhooks.webhook.filters.filters.filter
filtr wyzwalacza zasobów elementu webhook.

harmonogramy
Lista harmonogramów określa zaplanowane wyzwalacze dla potoku.

schedules.cron
Zaplanowany wyzwalacz określa harmonogram, w którym są tworzone gałęzie.

etapów
Etapy są kolekcją powiązanych zadań.

stages.stage
Etap A to kolekcja powiązanych zadań.

stages.template
Można zdefiniować zestaw etapów w jednym pliku i używać go wiele razy w innych plikach.

kroki
Kroki to liniowa sekwencja operacji tworzących zadanie.

steps.bash
Uruchamia skrypt w powłoce Bash w systemach Windows, macOS i Linux.

steps.checkout
Konfigurowanie sposobu sprawdzania kodu źródłowego potoku.

steps.download
pobiera artefakty skojarzone z bieżącym uruchomieniem lub z innego potoku platformy Azure skojarzonego jako zasób potoku.

steps.downloadBuild
Pobiera artefakty kompilacji.

steps.getPackage
Pobiera pakiet ze źródła danych zarządzania pakietami w usłudze Azure Artifacts lub Azure DevOps Server.

steps.powershell
Uruchamia skrypt przy użyciu programu Windows PowerShell (w systemie Windows) lub pwsh (Linux i macOS).

steps.publish
publikuje (przekazuje) plik lub folder jako artefakt potoku, z którego mogą korzystać inne zadania i potoki.

steps.pwsh
Uruchamia skrypt w programie PowerShell Core w systemach Windows, macOS i Linux.

steps.reviewApp
Pliki do pobrania tworzą zasób dynamicznie w ramach dostawcy fazy wdrażania.

steps.script
Uruchamia skrypt przy użyciu cmd.exe w systemach Windows i Bash na innych platformach.

steps.task
Uruchamia zadanie.

steps.template
Zdefiniuj zestaw kroków w jednym pliku i użyj go wiele razy w innym pliku.

docelowa
Zadania są uruchamiane w kontekście wykonywania, który jest hostem agenta lub kontenerem.

target.settableVariables
ograniczenia dotyczące zmiennych, które można ustawić.

wyzwalacza
wyzwalacz ciągłej integracji (wypychania).

zmiennych
Zdefiniuj zmienne przy użyciu par nazwa/wartość.

variables.group
zmienne referencyjne z grupy zmiennych.

variables.name
Zdefiniuj zmienne przy użyciu nazwy i pełnej składni.

variables.template
Zdefiniuj zmienne w szablonie.

Definicje pomocnicze

Uwaga

Definicje pomocnicze nie są przeznaczone do użytku bezpośrednio w potoku. Definicje pomocnicze są używane tylko w ramach innych definicji i są tu uwzględniane w celach referencyjnych.

deployHook
Służy do uruchamiania kroków wdrażania aplikacji.

includeExcludeFilters
Listy elementów do uwzględnienia lub wykluczenia.

includeExcludeStringFilters
Elementy do uwzględnienia lub wykluczenia.

mountReadOnly
woluminy do zainstalowania tylko do odczytu, wartość domyślna to fałsz.

onFailureHook
Służy do uruchamiania kroków dla akcji wycofywania lub czyszczenia.

onSuccessHook
Służy do uruchamiania kroków dla akcji wycofywania lub czyszczenia.

onSuccessOrFailureHook
Służy do uruchamiania kroków dla akcji wycofywania lub czyszczenia.

postRouteTrafficHook
Służy do uruchamiania kroków po kierowaniu ruchu. Zazwyczaj te zadania monitorują kondycję zaktualizowanej wersji dla zdefiniowanego interwału.

preDeployHook
Służy do uruchamiania kroków inicjowania zasobów przed rozpoczęciem wdrażania aplikacji.

routeTrafficHook
Służy do uruchamiania kroków obsługujących ruch do zaktualizowanej wersji.

obszaru roboczego
opcje obszaru roboczego na agencie.

Konwencje dokumentacji schematu YAML

Dokumentacja schematu YAML to szczegółowy przewodnik po potokach YAML usługi Azure Pipelines. Zawiera wykaz wszystkich obsługiwanych funkcji YAML i dostępnych opcji.

Poniżej przedstawiono konwencje składni używane w dokumentacji schematu YAML.

  • Po lewej stronie : jest słowo kluczowe literału używane w definicjach potoku.
  • Po prawej stronie : jest typ danych. Typ danych może być typem pierwotnym, takim jak ciąg lub odwołaniem do bogatej struktury zdefiniowanej gdzie indziej w tym odwołaniu.
  • Notacja [typu danych] wskazuje tablicę wymienionego typu definicji. Na przykład [ string ] jest tablicą ciągów.
  • Notacja {typ danych:typu danych} wskazuje mapowanie jednego typu danych na inny. Na przykład { string: string } to mapowanie ciągów na ciągi.
  • Symbol | wskazuje, że dla słowa kluczowego jest dostępnych wiele typów danych. Na przykład job | template oznacza, że dozwolona jest definicja zadania lub odwołanie do szablonu.

Zobacz też

Ta dokumentacja obejmuje schemat pliku YAML usługi Azure Pipelines. Aby poznać podstawy języka YAML, zobacz Learn YAML in Y Minutes. Usługa Azure Pipelines nie obsługuje wszystkich funkcji YAML. Nieobsługiwane funkcje obejmują kotwice, złożone klucze i zestawy. Ponadto w przeciwieństwie do standardowego kodu YAML usługa Azure Pipelines zależy od wyświetlania stage, job, tasklub skrótu zadania, takiego jak script jako pierwszy klucz w mapowaniu.