tarefa BatchScript@1 – Script do Lote v1

  • Artigo

Use esta tarefa para executar um Windows .bat ou .cmd script. Opcionalmente, o .bat script ou .cmd pode modificar permanentemente variáveis de ambiente.

Sintaxe

# Batch script v1
# Run a Windows command or batch script and optionally allow it to change the environment.
- task: BatchScript@1
  inputs:
    filename: # string. Required. Path. 
    #arguments: # string. Arguments. 
    #modifyEnvironment: False # boolean. Modify Environment. Default: False.
  # Advanced
    #workingFolder: # string. Working folder. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

# Batch Script v1
# Run a windows cmd or bat script and optionally allow it to change the environment.
- task: BatchScript@1
  inputs:
    filename: # string. Required. Path. 
    #arguments: # string. Arguments. 
    #modifyEnvironment: False # boolean. Modify Environment. Default: False.
  # Advanced
    #workingFolder: # string. Working folder. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

Entradas

filename - Caminho
string. Obrigatórios.

O caminho do .cmd script ou .bat a ser executado. Esse deve ser um caminho totalmente qualificado ou um relativo ao diretório de trabalho padrão. (Observe que o diretório de trabalho pode ser diferente de workingFolder, que pode ser especificado para esta tarefa.)


arguments - Argumentos
string.

Os argumentos passados para o .cmd script ou .bat .


modifyEnvironment - Modificar Ambiente
boolean. Valor padrão: False.

Determina se as modificações de variáveis de ambiente afetarão as tarefas subsequentes.


workingFolder - Pasta de trabalho
string.

O diretório de trabalho atual quando um script é executado. Isso usa como padrão a pasta em que o script está localizado.


failOnStandardError - Falha no Erro Padrão
boolean. Valor padrão: false.

Se isso for verdadeiro, essa tarefa falhará se algum erro for gravado no StandardError fluxo.


Opções de controle de tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Comentários

Use essa tarefa para executar um script do Windows .bat ou .cmd. Opcionalmente, permita que ele modifique permanentemente as variáveis de ambiente.

Observação

Essa tarefa não é compatível com contêineres do Windows. Se você precisar executar um script em lote em um contêiner do Windows, use a tarefa de linha de comando .

Para obter informações sobre como dar suporte a várias plataformas, consulte scripts multiplataforma.

Exemplos

Crie test.bat na raiz do repositório:

@echo off
echo Hello World from %AGENT_NAME%.
echo My ID is %AGENT_ID%.
echo AGENT_WORKFOLDER contents:
@dir %AGENT_WORKFOLDER%
echo AGENT_BUILDDIRECTORY contents:
@dir %AGENT_BUILDDIRECTORY%
echo BUILD_SOURCESDIRECTORY contents:
@dir %BUILD_SOURCESDIRECTORY%
echo Over and out.

Para executar esse script, adicione a tarefa a seguir ao pipeline.

- task: BatchScript@1
  inputs:
    filename: 'test.bat'

Requisitos

Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
É executado em Agent, DeploymentGroup
Demandas Os agentes auto-hospedados devem ter recursos que correspondam às seguintes demandas para executar trabalhos que usam esta tarefa: Cmd
Funcionalidades Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 1.83.0 ou superior
Categoria da tarefa Utilitário