BatchScript@1 - Attività Script batch v1

Articolo
07/02/2024

Usare questa attività per eseguire uno script o .cmd Windows.bat. Facoltativamente, lo .bat script o .cmd può modificare in modo permanente le variabili di ambiente.

Sintassi

# 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.

Input

filename - Percorso
string. Obbligatorio.

Percorso dello .cmd script o .bat da eseguire. Deve trattarsi di un percorso completo o di un percorso relativo alla directory di lavoro predefinita. Si noti che la directory di lavoro potrebbe essere diversa da workingFolder, che potrebbe essere specificata per questa attività.

arguments - Argomenti
string.

Argomenti passati allo .cmd script o .bat .

modifyEnvironment - Modificare l'ambiente
boolean. Valore predefinito: False.

Determina se le modifiche delle variabili di ambiente avranno effetto sulle attività successive.

workingFolder - Cartella di lavoro
string.

Directory di lavoro corrente quando viene eseguito uno script. Questa impostazione predefinita è la cartella in cui si trova lo script.

failOnStandardError - Esito negativo in caso di errore standard
boolean. Valore predefinito: false.

Se questo è vero, questa attività avrà esito negativo se vengono scritti errori nel StandardError flusso.

Opzioni di controllo attività

Tutte le attività hanno opzioni di controllo oltre ai relativi input dell'attività. Per altre informazioni, vedere Opzioni di controllo e proprietà comuni delle attività.

Variabili di output

No.

Osservazioni

Usare questa attività per eseguire uno script di Windows .bat o cmd. Facoltativamente, consentire di modificare in modo permanente le variabili di ambiente.

Nota

Questa attività non è compatibile con i contenitori di Windows. Se è necessario eseguire uno script batch in un contenitore di Windows, usare invece l'attività della riga di comando .

Per informazioni sul supporto di più piattaforme, vedere Scripting multipiattaforma.

Esempio

Creare test.bat nella radice del repository:

@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.

Per eseguire questo script, aggiungere l'attività seguente alla pipeline.

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

Requisiti

Requisito	Descrizione
Tipi di pipeline	YAML, build classica, versione classica
Viene eseguito in	Agente, DeploymentGroup
Richieste	Gli agenti self-hosted devono avere funzionalità che soddisfano le richieste seguenti per eseguire processi che usano questa attività: Cmd
Capabilities	Questa attività non soddisfa le richieste per le attività successive nel processo.
Restrizioni dei comandi	Qualsiasi
Variabili impostabili	Qualsiasi
Versione agente	1.83.0 o versione successiva
Categoria attività	Utilità

Condividi tramite