BatchScript@1 - Tâche de script batch v1

  • Article

Utilisez cette tâche pour exécuter un script Ou .cmd Windows.bat. Si vous le souhaitez, le script ou .cmd peut modifier définitivement les .bat variables d’environnement.

Syntax

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

Entrées

filename - Chemin
string. Obligatoire.

Chemin d’accès du .cmd script ou .bat à exécuter. Il doit s’agir d’un chemin d’accès complet ou d’un chemin d’accès par rapport au répertoire de travail par défaut. (Notez que le répertoire de travail peut différer de workingFolder, qui peut être spécifié pour cette tâche.)


arguments - Arguments
string.

Arguments passés au .cmd script ou .bat .


modifyEnvironment - Modifier l’environnement
boolean. Valeur par défaut : False.

Détermine si les modifications des variables d’environnement affecteront les tâches suivantes.


workingFolder - Dossier de travail
string.

Répertoire de travail actuel lors de l’exécution d’un script. Cette valeur est définie par défaut sur le dossier où se trouve le script.


failOnStandardError - Échec en cas d’erreur standard
boolean. Valeur par défaut : false.

Si cela est vrai, cette tâche échoue si des erreurs sont écrites dans le StandardError flux.


Options de contrôle des tâches

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâche. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Utilisez cette tâche pour exécuter un script Windows .bat ou .cmd. Si vous le souhaitez, autorisez-lui à modifier définitivement les variables d’environnement.

Notes

Cette tâche n’est pas compatible avec les conteneurs Windows. Si vous devez exécuter un script par lots sur un conteneur Windows, utilisez plutôt la tâche de ligne de commande .

Pour plus d’informations sur la prise en charge de plusieurs plateformes, consultez Script multiplateforme.

Exemples

Créez test.bat à la racine de votre référentiel :

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

Pour exécuter ce script, ajoutez la tâche suivante à votre pipeline.

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

Spécifications

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : Cmd
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes Quelconque
Variables settables Quelconque
Version de l’agent 1.83.0 ou version ultérieure
Catégorie de la tâche Utilitaire