ShellScript@2 - Tâche de script shell v2

Article
07/02/2024

Utilisez cette tâche pour exécuter un script shell à l’aide de bash.

Syntax

# Shell script v2
# Run a shell script using Bash.
- task: ShellScript@2
  inputs:
    scriptPath: # string. Required. Script Path. 
    #args: # string. Arguments. 
  # Advanced
    #disableAutoCwd: false # boolean. Specify Working Directory. Default: false.
    #cwd: # string. Optional. Use when disableAutoCwd = true. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

# Shell Script v2
# Run a shell script using bash.
- task: ShellScript@2
  inputs:
    scriptPath: # string. Required. Script Path. 
    #args: # string. Arguments. 
  # Advanced
    #disableAutoCwd: false # boolean. Specify Working Directory. Default: false.
    #cwd: # string. Optional. Use when disableAutoCwd = true. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

Entrées

scriptPath - Chemin d’accès du script
string. Obligatoire.

Spécifie le chemin d’accès relatif de la racine du dépôt au fichier de script shell que vous souhaitez exécuter.

args - Arguments
string.

Spécifie les arguments que vous souhaitez passer au script.

disableAutoCwd - Spécifier le répertoire de travail
boolean. Valeur par défaut : false.

Spécifie le répertoire de travail dans lequel la tâche exécute le script. Si la valeur est laissée vide, la tâche est définie par défaut sur le dossier où se trouve le script.

cwd - Répertoire de travail
string. facultatif. Utilisez quand disableAutoCwd = true.

Spécifie le répertoire de travail dans lequel le script est exécuté. Si la valeur est laissée vide, la tâche utilise la racine du dépôt (build) ou des artefacts (mise en production), qui est $(System.DefaultWorkingDirectory).

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

Si la valeur est true, la tâche échoue si des erreurs sont écrites dans le flux StandardError.

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âches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Où puis-je en savoir plus sur les scripts Bash ?

Débutants/BashScripting pour commencer.
Génial Bash pour aller plus loin.

Comment faire définir une variable afin qu’elle puisse être lue par les scripts et tâches suivants ?

Pour en savoir plus sur la définition de variables de build dans un script, consultez Définir et modifier vos variables de build dans un script.

Pour en savoir plus sur la définition de variables de mise en production dans un script, consultez Définir et modifier vos variables de mise en production dans un script

Exemples

Créez test.sh à la racine de votre dépôt. Nous vous recommandons de créer ce fichier à partir d’un environnement Linux (par exemple, une machine Linux réelle ou un Sous-système Windows pour Linux) afin que les fins de ligne soient correctes. En outre, n’oubliez pas de le valider chmod +x test.sh avant de le valider.

#!/bin/bash
echo "Hello World"
echo "AGENT_WORKFOLDER is $AGENT_WORKFOLDER"
echo "AGENT_WORKFOLDER contents:"
ls -1 $AGENT_WORKFOLDER
echo "AGENT_BUILDDIRECTORY is $AGENT_BUILDDIRECTORY"
echo "AGENT_BUILDDIRECTORY contents:"
ls -1 $AGENT_BUILDDIRECTORY
echo "SYSTEM_HOSTTYPE is $SYSTEM_HOSTTYPE"
echo "Over and out."

Ajoutez la tâche suivante à votre pipeline pour exécuter le script précédent.

- task: ShellScript@2
  inputs:
    scriptPath: 'test.sh'

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 : sh
Capabilities	Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande	Quelconque
Variables paramétrables	Quelconque
Version de l’agent	Toutes les versions d’agent prises en charge.
Catégorie de la tâche	Utilitaire

Partager via