Editor de pipeline YAML

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

O Azure Pipelines fornece um editor de pipeline YAML que você pode usar para criar e editar pipelines. O editor YAML é baseado no Monaco Editor. O editor fornece ferramentas como o suporte do IntelliSense e um assistente de tarefas para fornecer diretrizes enquanto você edita um pipeline.

Este artigo mostra como editar seus pipelines usando o editor de pipeline YAML, mas você também pode editar pipelines modificando o arquivo azure-pipelines.yml diretamente no repositório do pipeline usando um editor de texto de sua escolha ou usando uma ferramenta como o Visual Studio Code e a extensão Azure Pipelines para VS Code.

Editar um pipeline YAML

Para acessar o editor de pipeline YAML, execute as etapas a seguir.

1. Entrar em sua organização (https://dev.azure.com/{yourorganization}).

2. Selecione seu projeto, escolha Pipelines e escolha o pipeline que você deseja editar. Você pode procurar pipelines por Recentes, Todos, Execuções. Para obter mais informações, confira exibir e gerenciar seus pipelines.

   

3. Escolha Editar.

   

4. Faça edições no pipeline usando o Intellisense e o assistente de tarefa para obter orientações.

   

5. Selecione Validar e salvar. Você pode fazer commit diretamente em seu branch, criar um branch e, opcionalmente, iniciar uma solicitação de pull.

   

Usar atalhos do teclado

O editor de pipeline YAML fornece vários atalhos de teclado, que mostramos nos exemplos a seguir.

• Escolha Ctrl+Space para abrir o suporte do Intellisense enquanto você está editando o pipeline YAML.

  

• Escolha F1 (Fn+F1 no Mac) para exibir a paleta de comandos e os atalhos de teclado disponíveis.

  

Usar o assistente de tarefa

O assistente de tarefa fornece um método para adicionar tarefas ao pipeline YAML.

• Para exibir o assistente de tarefa, edite seu pipeline YAML e escolha Mostrar assistente.

  

• Para ocultar o assistente de tarefa, escolha Ocultar assistente.

  

• Para usar o assistente de tarefa, procure ou pesquise tarefas no painel Tarefas.

  

• Selecione a tarefa desejada e configure suas entradas.

  

• Escolha Adicionar para inserir o YAML da tarefa em seu pipeline.

• Você pode editar o YAML para fazer mais alterações de Configuração na tarefa ou pode escolher Configurações acima da tarefa no editor de pipeline YAML para configurar a tarefa inserida no assistente de tarefa.

Validar

Valide suas alterações para capturar erros de sintaxe no pipeline que o impedem de iniciar. Escolha Mais ações>Validar.

O Azure Pipelines valida seus pipelines sempre que você salvar. Selecione Validar e salvar para validar seu pipeline antes de salvar. Se houver algum erro, você pode Cancelar ou Salvar mesmo assim. Para salvar seu pipeline sem validar, selecione Salvar sem validar.

O Azure Pipelines detecta definições de variáveis incorretas definidas no nível de pipeline, estágio e trabalho e detecta condições incorretas de YAML definidas no nível de pipeline, estágio e trabalho.

Baixar YAML completo

Você pode visualizar o documento YAML totalmente analisado sem confirmar ou executar o pipeline. Escolha Mais ações>Baixar YAML completo.

Baixar YAML completo Executa a API REST do Azure DevOps para Pipelines do Azure e inicia um download do YAML renderizado do editor.

Gerenciar variáveis de pipeline

Você pode gerenciar variáveis de pipeline de dentro do pipeline YAML e da interface do usuário nas configurações do pipeline.

Para gerenciar variáveis de pipeline, execute as etapas a seguir.

1. Edite seu pipeline YAML e escolha Variáveis para gerenciar variáveis de pipeline.

   

2. Escolha entre as seguintes funções:

   • Nova variável: para adicionar sua primeira variável.
   • Adicionar : para adicionar variáveis subsequentes.
   • Nome da variável para editar uma variável.
   • Delete : para excluir uma variável.

   

Para gerenciar variáveis de pipelines na interface do usuário de configurações de pipeline, execute as etapas a seguir.

1. Edite o pipeline e escolha Mais ações>Gatilhos.

   

2. Escolha Variáveis.

   

Para obter mais informações sobre como trabalhar com variáveis de pipeline, confira Definir variáveis.

Configurar o pool de agentes padrão

Se um pipeline YAML não especificar um pool de agentes, o pool de agentes definido na configuração Pool de agentes padrão para YAML será usado. Esse pool também é usado para tarefas de limpeza pós-execução.

Para exibir e definir a configuração Pool de agentes padrão para YAML:

1. Edite o pipeline e escolha Mais ações>Gatilhos.

   

2. Escolha YAML e selecione o pool de agentes desejado usando a lista suspensa Pool de agentes padrão para YAML.

   

O pool de agentes padrão para YAML é configurado por pipeline.

Gerenciar configurações usando a interface do usuário de configurações de pipeline

Algumas configurações de pipeline YAML são definidas usando a interface do usuário de configurações de pipeline em vez de no arquivo YAML.

1. Edite o pipeline e escolha Mais ações>Gatilhos.

   

2. Na interface do usuário de configurações de pipeline, escolha a guia da configuração a ser configurada.

   

Exibir e editar modelos

Os modelos são um recurso comumente usado em pipelines YAML. Eles são uma maneira fácil de compartilhar snippets de pipeline e são um mecanismo poderoso para verificar e impor a segurança e a governança em seu pipeline. Anteriormente, o editor não dava suporte a modelos, portanto, os autores de pipelines YAML não podiam aproveitar a assistência do intellisense. Agora, o Azure Pipelines dá suporte a um editor YAML, cujo suporte está em versão prévia. Para habilitar essa versão prévia, acesse visualizar recursos em sua organização do Azure DevOps e habilite o editor de modelos YAML.

Importante

Esse recurso tem as seguintes limitações.

• Se o modelo tiver parâmetros obrigatórios que não são fornecidos como entradas no arquivo YAML principal, a validação falhará e solicitará que você as forneça.

• Não é possível criar um modelo do editor. Você só pode usar ou editar modelos existentes.

Ao editar seu arquivo YAML principal do Azure Pipelines, você pode incluir ou estender um modelo. Ao inserir o nome do modelo, poderá ser solicitado que você valide seu modelo. Depois de validado, o editor YAML entende o esquema do modelo, incluindo os parâmetros de entrada.

Após a validação, você pode entrar no modelo escolhendo Exibir modelo. Isso abrirá o modelo em uma nova guia do navegador na qual você poderá fazer alterações usando todos os recursos do editor YAML.

Próximas etapas

Personalizar o pipeline

Artigos relacionados

• Saiba como navegar e exibir seus pipelines
• Criar seu primeiro pipeline