Справочник по схеме YAML для Azure Pipelines

Справочник по схеме YAML для Azure Pipelines — это подробный справочник по конвейерам YAML, в списке всех поддерживаемых синтаксисов YAML и их доступных параметров.

Чтобы создать конвейер YAML, начните с определения конвейера. Дополнительные сведения о создании конвейеров YAML см. в статье Настройкаконвейера.

Справочник по схеме YAML не охватывает задачи. Дополнительные сведения о задачах см. в индексе задач Azure Pipelines.

Определения

конвейера
Конвейер — это один или несколько этапов, описывающих процесс CI/CD. Определение конвейера содержит документацию по свойствам корневого уровня, таким как name.

расширяет
расширяет конвейер с помощью шаблона.

заданий
Указывает задания, составляющие работу этапа.

jobs.deployment
Задание развертывания — это особый тип задания. Это коллекция шагов для последовательного выполнения в среде.

jobs.deployment.environment
имя целевой среды и необязательно имя ресурса для записи журнала развертывания; формат: environment-name.resource-name.

jobs.deployment.strategy
стратегия выполнения для этого развертывания.

jobs.deployment.strategy.canary
стратегия развертывания Canary.

jobs.deployment.strategy.rolling
стратегию скользящего развертывания.

jobs.deployment.strategy.runOnce
стратегии развертывания RunOnce.

job.job
Задание — это коллекция шагов, выполняемых агентом или сервером.

job.job.container
имя ресурса контейнера.

job.job.strategy
стратегии выполнения для этого задания.

jobs.job.uses
Все ресурсы, необходимые этому заданию, которые еще не ссылаются.

jobs.template
набор заданий, определенных в шаблоне.

параметров
Указывает параметры среды выполнения, передаваемые конвейеру.

parameters.parameter
параметры шаблона конвейера.

пула
Какой пул будет использоваться для задания конвейера.

pool.demands
требования (для частного пула).

pr
триггер запроса на вытягивание.

ресурсов
Ресурсы указывают сборки, репозитории, конвейеры и другие ресурсы, используемые конвейером.

resources.builds
Список ресурсов сборки, на которые ссылается конвейер.

resources.builds.build
ресурс сборки, используемый для ссылки на артефакты из запуска.

resources.containers
список образов контейнеров.

resources.container.container
Ресурс контейнера, используемый для ссылки на образ контейнера.

resources.container.container.trigger
Укажите значение none, true, чтобы активировать все теги изображений или использовать полный синтаксис, как описано в следующих примерах.

resources.packages
список ресурсов пакета.

resources.packages.package
ресурс пакета, используемый для ссылки на пакет NuGet или npm GitHub.

resources.pipelines
список ресурсов конвейера.

resources.pipelines.pipeline
ресурс конвейера.

resources.pipelines.pipeline.trigger
Укажите значение none, true, чтобы включить все ветви или использовать полный синтаксис, как описано в следующих примерах.

resources.pipelines.pipeline.trigger.branches
Ветви для включения или исключения для активации выполнения.

resources.repositories
Список ресурсов репозитория.

resources.repositories.repository
ресурс репозитория используется для ссылки на дополнительный репозиторий в конвейере.

resources.webhooks
список веб-перехватчиков.

resources.webhooks.webhook
Ресурс веб-перехватчика позволяет интегрировать конвейер с внешней службой для автоматизации рабочего процесса.

resources.webhooks.webhook.filters
список фильтров триггеров.

resources.webhooks.webhook.filters.filters.filter
фильтр триггера ресурса веб-перехватчика.

расписания
Список расписаний указывает запланированные триггеры для конвейера.

schedules.cron
Запланированный триггер указывает расписание, в котором создаются ветви.

этапы
этапы — это коллекция связанных заданий.

stage.stage
Этап — это коллекция связанных заданий.

этапов.template
Можно определить набор этапов в одном файле и использовать его несколько раз в других файлах.

шаги
шаги — это линейная последовательность операций, составляющих задание.

steps.bash
выполняет скрипт в Bash в Windows, macOS и Linux.

steps.checkout
Настройка проверки исходного кода конвейера.

steps.download
Загружает артефакты, связанные с текущим запуском или из другого azure Pipeline, связанного с ресурсом конвейера.

steps.downloadBuild
Скачивает артефакты сборки.

steps.getPackage
скачивает пакет из веб-канала управления пакетами в Azure Artifacts или Azure DevOps Server.

steps.powershell
выполняет скрипт с помощью Windows PowerShell (в Windows) или pwsh (Linux и macOS).

steps.publish
публикует (отправляет) файл или папку в качестве артефакта конвейера, который могут использовать другие задания и конвейеры.

steps.pwsh
выполняет скрипт в PowerShell Core в Windows, macOS и Linux.

steps.reviewApp
Загрузки создают ресурс динамически при развертывании поставщика этапов развертывания.

steps.script
выполняет скрипт с помощью cmd.exe в Windows и Bash на других платформах.

steps.task
Выполняет задачу.

steps.template
определить набор шагов в одном файле и использовать его несколько раз в другом файле.

целевой
Задачи выполняются в контексте выполнения, который является узлом агента или контейнером.

target.settableVariables
ограничения, для которых можно задать переменные.

триггера
триггер непрерывной интеграции (push).

переменных
Определять переменные с помощью пар "имя-значение".

переменные.group
Ссылочные переменные из группы переменных.

variables.name
определять переменные с помощью имени и полного синтаксиса.

переменные.template
Определить переменные в шаблоне.

Вспомогательные определения

Примечание.

Вспомогательные определения не предназначены для использования непосредственно в конвейере. Вспомогательные определения используются только как часть других определений и включены здесь для справки.

deployHook
Используется для выполнения шагов, которые развертывают приложение.

includeExcludeFilters
списки элементов для включения или исключения.

includeExcludeStringFilters
элементы для включения или исключения.

mountReadOnly
тома для подключения только для чтения значение по умолчанию равно false.

onFailureHook
Используется для выполнения шагов для действий отката или очистки.

onSuccessHook
Используется для выполнения шагов для действий отката или очистки.

onSuccessOrFailureHook
Используется для выполнения шагов для действий отката или очистки.

postRouteTrafficHook
Используется для выполнения шагов после маршрутизации трафика. Как правило, эти задачи отслеживают работоспособность обновленной версии для определенного интервала.

preDeployHook
Используется для выполнения шагов, которые инициализируют ресурсы перед началом развертывания приложения.

routeTrafficHook
Используется для выполнения шагов, которые служат трафику в обновленную версию.

рабочей области
параметры рабочей области агента.

Соглашения о документации по схеме YAML

Справочник по схеме YAML — это подробное руководство по конвейерам YAML Azure Pipelines. Он включает в себя каталог всех поддерживаемых возможностей YAML и доступных параметров.

Ниже приведены соглашения о синтаксисе, используемые в справочнике по схеме YAML.

• Слева от : является литеральным ключевым словом, используемым в определениях конвейера.
• Справа от : находится тип данных. Тип данных может быть примитивным типом, например строковым или ссылкой на богатую структуру, определенную в другом месте этой ссылки.
• Нотация [типа данных] указывает массив указанного типа определения. Например, [ string ] представляет собой массив строк.
• Нотация {типа данных:} указывает сопоставление одного типа данных с другим. Например, { string: string } — это сопоставление строк с строками.
• Символ | указывает, что для ключевого слова доступно несколько типов данных. Например, job | template означает, что разрешено определение задания или ссылка на шаблон.

См. также

Эта ссылка охватывает схему YAML-файла Azure Pipelines. Сведения об основах YAML см. в статье Learn YAML в минутах Y. Azure Pipelines не поддерживает все функции YAML. Неподдерживаемые функции включают привязки, сложные ключи и наборы. Кроме того, в отличие от стандартного YAML, Azure Pipelines зависит от просмотра stage, job, taskили ярлыка задачи, например script в качестве первого ключа в сопоставлении.