steps.bash definition
The bash
step runs a script in Bash on Windows, macOS, and Linux.
steps:
- bash: string # Required as first property. An inline script.
failOnStderr: string # Fail the task if output is sent to Stderr?
workingDirectory: string # Start the script with this working directory.
condition: string # Evaluate this condition expression to determine whether to run this task.
continueOnError: boolean # Continue running even on failure?
displayName: string # Human-readable name for the task.
target: string | target # Environment in which to run this task.
enabled: boolean # Run this task when the job runs?
env: # Variables to map into the process's environment.
string: string # Name/value pairs
name: string # ID of the step.
timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
retryCountOnTaskFailure: string # Number of retries if the task fails.
steps:
- bash: string # Required as first property. An inline script.
failOnStderr: string # Fail the task if output is sent to Stderr?
workingDirectory: string # Start the script with this working directory.
condition: string # Evaluate this condition expression to determine whether to run this task.
continueOnError: boolean # Continue running even on failure?
displayName: string # Human-readable name for the task.
target: string | target # Environment in which to run this task.
enabled: boolean # Run this task when the job runs?
env: # Variables to map into the process's environment.
string: string # Name/value pairs
name: string # ID of the step.
timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
steps:
- bash: string # Required as first property. An inline script.
failOnStderr: string # Fail the task if output is sent to Stderr?
workingDirectory: string # Start the script with this working directory.
condition: string # Evaluate this condition expression to determine whether to run this task.
continueOnError: boolean # Continue running even on failure?
displayName: string # Human-readable name for the task.
enabled: boolean # Run this task when the job runs?
env: # Variables to map into the process's environment.
string: string # Name/value pairs
name: string # ID of the step.
timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
Definitions that reference this definition: steps
Properties
bash
string. Required as first property.
An inline script.
failOnStderr
string.
Fail the task if output is sent to Stderr?
workingDirectory
string.
Start the script with this working directory.
condition
string.
Evaluate this condition expression to determine whether to run this task.
continueOnError
boolean.
Continue running even on failure?
displayName
string.
Human-readable name for the task.
target
target.
Environment in which to run this task.
enabled
boolean.
Run this task when the job runs?
env
string dictionary.
Variables to map into the process's environment.
name
string.
ID of the step. Acceptable values: [-_A-Za-z0-9]*.
timeoutInMinutes
string.
Time to wait for this task to complete before the server kills it.
Note
Pipelines may be configured with a job level timeout. If the job level timeout interval elapses before your step completes, the running job (including your step) is terminated, even if the step is configured with a longer timeoutInMinutes
interval. For more information, see Timeouts.
retryCountOnTaskFailure
string.
Number of retries if the task fails.
Remarks
The bash
keyword is a shortcut for the shell script task.
The task runs a script in Bash on Windows, macOS, and Linux.
Learn more about conditions, timeouts, and step targets.
Examples
steps:
- bash: |
which bash
echo Hello $name
displayName: Multiline Bash script
env:
name: Microsoft
If you don't specify a command mode, you can shorten the target
structure to:
- bash:
target: string # container name or the word 'host'
See also
- shell script task
- Learn more about conditions, timeouts, and step targets