Referência de tarefa do Azure Pipelines

Uma tarefa executa uma ação em um pipeline. Por exemplo, uma tarefa pode criar um aplicativo, interagir com recursos do Azure, instalar uma ferramenta ou executar um teste. As tarefas são os blocos de construção para definir a automação em um pipeline.

Os artigos nesta seção descrevem as tarefas internas do Azure Pipelines e especificam a semântica para atributos que têm um significado especial para cada tarefa.

Consulte a referência YAML para steps.task para obter detalhes sobre os atributos gerais compatíveis com as tarefas.

Para obter instruções e tutoriais sobre como criar pipelines usando tarefas, incluindo a criação de tarefas personalizadas, extensões personalizadas e a localização de tarefas no Visual Studio Marketplace, consulte conceitos de Tarefas e documentação do Azure Pipelines.

Código aberto

Essas tarefas são de software livre no GitHub. Comentários e contribuições são bem-vindos. Consulte da caixa de alteração de tarefa pipeline para obter uma lista de alterações de tarefa, incluindo um registro histórico de atualizações de tarefas.

Perguntas Freqüentes

O que são aliases de entrada de tarefa?

As entradas para uma tarefa são identificadas por um label, namee podem incluir um ou mais aliasesopcionais. O exemplo a seguir é um trecho do de código-fonte para a entrada de Entrada de Hosts Conhecidos da tarefa InstallSSHKey@0.

{
    "name": "hostName",
    "aliases": [
        "knownHostsEntry"
    ],
    "label": "Known Hosts Entry"
    ...
}

Antes dos pipelines YAML serem introduzidos em 2019, os pipelines eram criados e editados usando um editor de pipeline baseado em interface do usuário, e apenas o label era usado por autores de pipeline para fazer referência a uma entrada de tarefa.

Quando os pipelines YAML foram introduzidos em 2019, os autores de pipeline usando YAML começaram a usar a entrada de tarefa name para se referir a uma entrada de tarefa. Em alguns casos, os nomes de entrada da tarefa não eram descritivos, portanto, aliases foram adicionados para fornecer nomes descritivos adicionais para entradas de tarefa.

Por exemplo, a tarefa tem uma entrada de Entrada de Hosts Conhecidos chamada que espera uma entrada de um arquivo known_hosts. O rótulo entrada de hosts conhecidos no designer de pipeline clássico deixa isso claro, mas não é tão claro ao usar o nome em um pipeline YAML. Os aliases de entrada da tarefa foram introduzidos para permitir que os autores de tarefas fornecessem nomes descritivos para suas tarefas criadas anteriormente e, para a tarefa InstallSSHKey@0, um alias knownHostsEntryfoi adicionado, mantendo o nome hostName original para compatibilidade com pipelines existentes usando esse nome.

Todos os itens no aliases de uma entrada de tarefa são intercambiáveis com o name em um pipeline YAML. Os dois snippets YAML a seguir são funcionalmente idênticos, com o primeiro exemplo usando o alias knownHostsEntry e o segundo exemplo usando hostName.

- task: InstallSSHKey@0
  inputs:
    # Using knownHostsEntry alias
    knownHostsEntry: 'sample known hosts entry line'
    # Remainder of task inputs omitted

- task: InstallSSHKey@0
  inputs:
    # Using hostName name
    hostName: 'sample known hosts entry line'
    # Remainder of task inputs omitted

A partir do Azure DevOps Server 2019.1, o editor de pipeline do YAML foi introduzido, que fornece uma funcionalidade de tipo intellisense.

O editor de pipeline yaml usa o Yamlschema – Obter API REST para recuperar o esquema usado para validação no editor. Se uma entrada de tarefa tiver um alias, o esquema promoverá o alias para o nome YAML primário para a entrada da tarefa e o alias será sugerido pelo intellisense.

O exemplo a seguir é a entrada de tarefa Entrada de Hosts Conhecidos para a tarefa InstallSSHKey@0 do esquema YAML, com knownHostsEntry listados na posição de nome e hostName na coleção aliases.

"properties": {
    "knownHostsEntry": {
      "type": "string",
      "description": "Known Hosts Entry",
      "ignoreCase": "key",
      "aliases": [
        "hostName"
      ]
    },

Como o intellisense no editor de pipeline yaml exibe knownHostsEntrye o YAML gerado pelo assistente de tarefa usa knownHostsEntry no YAML gerado, a referência de tarefa exibe o alias do código-fonte da tarefa como o nome YAML para uma entrada de tarefa. Se uma tarefa tiver mais de um alias (há alguns que têm dois aliases), o primeiro alias será usado como o nome.

Por que a referência à tarefa foi alterada?

A documentação de referência de tarefas do Azure Pipelines foi movida para seu local atual para dar suporte às melhorias a seguir.

• Os artigos de tarefa são gerados usando o código-fonte da tarefa das tarefas do ade repositório de software livre do Azure Pipelines.
• Os nomes de entrada e os aliases da tarefa são gerados da origem da tarefa para que estejam sempre atualizados.
• Os blocos de sintaxe YAML são gerados da origem da tarefa para que estejam atualizados.
• Dá suporte a contribuições da comunidade com conteúdo integrado do usuário, como descrições de entrada de tarefas aprimoradas, comentários e exemplos.
• Fornece cobertura de tarefas para todas as versões do Azure DevOps com suporte.
• Atualizado a cada sprint para cobrir as atualizações mais recentes.

Para contribuir, consulte Contribuindo para o conteúdo das tarefas.

Onde posso aprender passo a passo como criar meu aplicativo?

criar seu aplicativo

Posso adicionar minhas próprias tarefas de build?

Sim: Adicionar uma tarefa de build

O que são tarefas do instalador?

Para saber mais sobre as tarefas do instalador de ferramentas, consulte Instaladores da Ferramenta.