Редактор конвейеров YAML

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Azure Pipelines предоставляет редактор конвейеров YAML, который можно использовать для создания и редактирования конвейеров. Редактор YAML основан на редакторе Монако. Редактор предлагает такие средства, как поддержка IntelliSense и помощник по задачам для предоставления рекомендаций при редактировании конвейера.

В этой статье показано, как редактировать конвейеры с помощью редактора конвейера YAML, но вы также можете изменять конвейеры, изменив файл azure-pipelines.yml непосредственно в репозитории конвейера с помощью текстового редактора или с помощью средства, например Visual Studio Code и расширения Azure Pipelines для VS Code .

Внимание

Редактор конвейера YAML появился в Azure DevOps Server 2019 с обновлением 1. Если вы используете Azure DevOps Server 2019 RTW, редактор конвейера YAML, описанный в этой статье, недоступен, но вы можете изменить YAML с помощью текстового редактора и проверка его в репозиторий конвейера.

Изменение конвейера YAML

Чтобы получить доступ к редактору конвейера YAML, выполните следующие действия.

  1. Войдите в свою организацию (https://dev.azure.com/{yourorganization}).

  2. Выберите проект, выберите конвейеры конвейеров>, а затем выберите конвейер, который нужно изменить.

    Azure Pipelines builds in Azure DevOps Server 2019 Update 1.

  3. Выберите Изменить.

    Azure Pipelines YAML edit button in Azure DevOps Server 2019 Update 1.

  4. Внесите изменения в конвейер с помощью сочетаний клавиш Intellisense и задачи помощник для получения рекомендаций.

    YAML pipeline editor in Azure DevOps Server 2019.1.

Чтобы получить доступ к редактору конвейера YAML, выполните следующие действия.

  1. Войдите в свою организацию (https://dev.azure.com/{yourorganization}).

  2. Выберите проект, выберите конвейер, а затем выберите конвейер, который требуется изменить. Конвейеры можно просматривать по последним, всем и запускам. Дополнительные сведения см. в представлении конвейеров и управлении ими.

    Azure Pipelines landing page.

  3. Выберите Изменить.

    Azure Pipelines YAML edit button.

  4. Внесите изменения в конвейер с помощью Intellisense и задачи помощник для получения рекомендаций.

    YAML pipeline editor.

  1. Нажмите кнопку Сохранить. Вы можете зафиксировать непосредственно в ветви или создать новую ветвь и при необходимости запустить запрос на вытягивание.

    YAML pipeline editor save window.

  1. Выберите " Проверить и сохранить". Вы можете зафиксировать непосредственно в ветви или создать новую ветвь и при необходимости запустить запрос на вытягивание.

    Screenshot showing the YAML pipeline editor validate and save window.

Использование сочетаний клавиш

Редактор конвейера YAML предоставляет несколько сочетаний клавиш, которые показаны в следующих примерах.

  • При редактировании конвейера YAML выберите сочетание клавиш CTRL+SPACE для Intellisense.

    YAML pipeline editor intellisense.

  • Выберите F1 (Fn+F1 на Mac), чтобы отобразить палитру команд и просмотреть доступные сочетания клавиш.

    YAML pipeline editor command palette.

Использование помощник задач

Задача помощник предоставляет метод добавления задач в конвейер YAML.

  • Чтобы отобразить помощник задачи, измените конвейер YAML и выберите "Показать помощник".

    Show ask assistant for editing YAML pipelines.

  • Чтобы скрыть помощник задачи, нажмите кнопку "Скрыть помощник".

    Hide task assistant for editing YAML pipelines.

  • Чтобы использовать задачу помощник, найдите или найдите задачи в области задач.

    Task assistant search.

  • Выберите нужную задачу и настройте входные данные.

    Task assistant add.

  • Нажмите кнопку "Добавить", чтобы вставить yamL задачи в конвейер.

Task assistant added in Azure DevOps Server 2019.

  • Измените вставленный YAML, чтобы внести дополнительные изменения конфигурации в задачу.

Task assistant added.

  • Вы можете изменить YAML, чтобы внести дополнительные изменения конфигурации в задачу или выбрать Параметры над задачей в редакторе конвейера YAML, чтобы настроить вставленную задачу в помощник задачи.

Проверить

Проверьте изменения, чтобы перехватывать синтаксические ошибки в конвейере, которые препятствуют его запуску. Выберите "Дополнительные действия", чтобы>проверить.

Validate and Download full YAML.

Azure Pipelines проверяет конвейеры при каждом сохранении. Выберите " Проверить и сохранить", чтобы проверить конвейер перед сохранением . Если есть ошибки, вы можете отменить или сохранить в любом случае. Чтобы сохранить конвейер без проверки, нажмите кнопку "Сохранить" без проверки.

Screenshot showing the Validate and save button.

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

Скачивание полного YAML

Вы можете просмотреть полностью проанализированный документ YAML без фиксации или запуска конвейера. Выберите "Дополнительные действия>", чтобы скачать полный YAML.

Validate and Download full YAML.

Скачайте полный интерфейс YAMLЗапускает REST API Azure DevOps для Azure Pipelines и инициирует скачивание отрисованного YAML из редактора.

Управление переменными конвейера

Переменные конвейера можно управлять как из конвейера YAML, так и из пользовательского интерфейса параметров конвейера.

С помощью Azure DevOps 2019 с обновлением 1 вы можете управлять переменными конвейера с помощью пользовательского интерфейса параметров конвейера.

Чтобы управлять переменными конвейера, выполните следующие действия.

  1. Измените конвейер YAML и выберите переменные для управления переменными конвейера.

    Manage pipeline variables button.

  2. Выберите следующие функции:

    • Новая переменная: чтобы добавить первую переменную.
    • Добавьте : для добавления последующих переменных.
    • Имя переменной для изменения переменной.
    • Удаление : для удаления переменной.

    Manage pipeline variables in the YAML editor.

Чтобы управлять переменными конвейеров в пользовательском интерфейсе параметров конвейера, выполните следующие действия.

  1. Измените конвейер и выберите "Дополнительные триггеры действий>".

    Pipeline settings UI menu.

  2. Выберите переменные.

    Pipeline settings UI for variables.

Дополнительные сведения о работе с переменными конвейера см. в разделе "Определение переменных".

Настройка пула агентов по умолчанию

Если конвейер YAML не указывает пул агентов, используется пул агентов, настроенный в пуле агентов по умолчанию для параметра YAML . Этот пул также используется для задач очистки после запуска.

Чтобы просмотреть и настроить пул агентов по умолчанию для параметра YAML :

  1. Измените конвейер и выберите "Дополнительные триггеры действий>".

    Screenshot of the pipeline settings UI menu.

  2. Выберите YAML и выберите нужный пул агентов с помощью пула агентов по умолчанию для раскрывающегося списка YAML.

    Screenshot of the default agent pool for YAML pipelines.

Пул агентов по умолчанию для YAML настраивается на основе каждого конвейера.

Управление параметрами с помощью пользовательского интерфейса параметров конвейера

Некоторые параметры конвейера YAML настраиваются с помощью пользовательского интерфейса параметров конвейера вместо YAML-файла.

  1. Измените конвейер и выберите "Дополнительные триггеры действий>".

    Screenshot of the pipeline settings UI menu.

  2. В пользовательском интерфейсе параметров конвейера выберите вкладку для настройки параметра.

    Screenshot of the pipeline settings UI for triggers.

Просмотр и изменение шаблонов

Примечание.

Эта функция доступна начиная с Azure DevOps Server 2022.1.

Шаблоны часто используются в конвейерах YAML. Это простой способ совместного использования фрагментов конвейера и мощный механизм проверки и применения безопасности и управления в конвейере. Ранее редактор не поддерживал шаблоны, поэтому авторы конвейеров YAML не могли получить помощь intellisense. Теперь Azure Pipelines поддерживает редактор YAML, для которого мы просматриваем поддержку. Чтобы включить эту предварительную версию, перейдите к предварительным версиям функций в организации Azure DevOps и включите редактор шаблонов YAML.

Внимание

Эта функция имеет следующие ограничения.

  • Если шаблон имеет необходимые параметры, которые не предоставляются в качестве входных данных в основном файле YAML, проверка завершается ошибкой и запрашивает предоставление этих входных данных.

  • Невозможно создать новый шаблон из редактора. Вы можете использовать только существующие шаблоны или изменять их.

При изменении основного файла YAML Azure Pipelines можно включить или расширить шаблон. При вводе имени шаблона может появиться запрос на проверку шаблона. После проверки редактор YAML понимает схему шаблона, включая входные параметры.

YAML template.

После проверки вы можете перейти к шаблону, выбрав шаблон "Вид", который открывает шаблон на новой вкладке браузера. Вы можете внести изменения в шаблон с помощью всех функций редактора YAML.

Следующие шаги