Azure Pipelines task reference

Uma tarefa executa uma ação em um pipeline. Por exemplo, uma tarefa pode construir uma aplicação, 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 desta secção descrevem as tarefas incorporadas para o Azure Pipelines e especificam a semântica para atributos que têm um significado especial para cada tarefa.

Consulte o Referência YAML para steps.task para obter detalhes sobre os atributos gerais suportados pelas tarefas.

Para tutoriais e tutoriais sobre como criar pipelines usando tarefas, incluindo a criação de tarefas personalizadas, extensões personalizadas e a procura de tarefas no Visual Studio Marketplace, veja Tarefas e Azure Pipelines documentação.

Código aberto

Estas tarefas são open source on GitHub. Comentários e contribuições são bem-vindos. Consulte do changelog de tarefas do pipeline para obter uma lista de alterações de tarefas, incluindo um registro histórico de atualizações de tarefas.

FAQ

O que são aliases de entrada de tarefas?

As entradas para uma tarefa são identificadas por um label, namee podem incluir uma ou mais aliasesopcionais. O exemplo a seguir é um trecho do de código-fonte para a entrada Entrada de Hosts Conhecidos do 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 pelos autores do pipeline para fazer referência a uma entrada de tarefa.

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

Por exemplo, a tarefa InstallSSHKey@0 tem uma entrada Entrada de Hosts Conhecidos chamada hostName que espera uma entrada de um arquivo known_hosts. O rótulo Known Hosts Entry no designer de pipeline clássico deixa isso claro, mas não é tão claro ao usar o nome hostName em um pipeline YAML. Os aliases de entrada de tarefas foram introduzidos para permitir que os autores de tarefas forneçam nomes decriptivos 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 entrada de uma tarefa são intercambiáveis com o name em um pipeline YAML. Os dois trechos de 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 de Azure DevOps Server 2019.1, foi introduzido o editor de pipeline YAML, que fornece uma funcionalidade do tipo intellisense.

O editor de pipeline YAML usa o Yamlschema - Get REST API 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 de tarefa, e o alias será sugerido pelo intellisense.

O exemplo a seguir é a entrada de tarefa Known Hosts Entry para a tarefa InstallSSHKey@0 do esquema YAML, com knownHostsEntry listado no nome, posição 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 da tarefa mudou?

A documentação de referência de tarefas do Azure Pipelines foi transferida para a sua localização atual para suportar as seguintes melhorias.

• Os artigos de tarefa são gerados usando o código-fonte da tarefa do repositório Azure Pipelines tarefas open source.
• Os nomes e aliases de entrada de tarefas são gerados a partir da fonte da tarefa para que estejam sempre atualizados.
• Os blocos de sintaxe YAML são gerados a partir da fonte da tarefa para que estejam atualizados.
• Suporta contribuições da comunidade com conteúdo de usuário integrado, como descrições aprimoradas de entrada de tarefas, comentários e exemplos.
• Fornece cobertura de tarefas para todas as versões suportadas de Azure DevOps.
• 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?

Crie seu aplicativo

Posso adicionar minhas próprias tarefas de compilação?

Sim: Adicionar uma tarefa de compilação

O que são tarefas do instalador?

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

Versões anteriores

• Azure DevOps Server referência de tarefa 2020.1
• Azure DevOps Server Referência de tarefa 2020
• Azure DevOps Server Referência de tarefa 2019.1
• Azure DevOps Server Referência de tarefa de 2019
• Referência de tarefa TFS 2018