Skip to content

Latest commit

 

History

History
247 lines (195 loc) · 8.07 KB

steps-bash.md

File metadata and controls

247 lines (195 loc) · 8.07 KB
Raw
title description ms.date monikerRange
steps.bash definition
Runs a script in Bash on Windows, macOS, and Linux.
03/02/2023
>=azure-pipelines-2019

steps.bash definition

:::moniker range=">=azure-pipelines-2019"

The bash step runs a script in Bash on Windows, macOS, and Linux.

:::moniker-end

:::moniker range=">=azure-pipelines-2022"

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.

:::moniker-end

:::moniker range=">=azure-pipelines-2020 <=azure-pipelines-2020.1"

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.

:::moniker-end

:::moniker range=">=azure-pipelines-2019 <=azure-pipelines-2019.1"

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.

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

Definitions that that reference this definition: steps

:::moniker-end

Properties

:::moniker range=">=azure-pipelines-2019"

bash string. Required as first property.
An inline script.

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

failOnStderr string.
Fail the task if output is sent to Stderr?

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

workingDirectory string.
Start the script with this working directory.

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

condition string.
Evaluate this condition expression to determine whether to run this task.

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

continueOnError boolean.
Continue running even on failure?

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

displayName string.
Human-readable name for the task.

:::moniker-end

:::moniker range=">=azure-pipelines-2020"

target target.
Environment in which to run this task.

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

enabled boolean.
Run this task when the job runs?

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

env string dictionary.
Variables to map into the process's environment.

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

name string.
ID of the step. Acceptable values: [-_A-Za-z0-9]*.

:::moniker-end

:::moniker range=">=azure-pipelines-2019"

timeoutInMinutes string.
Time to wait for this task to complete before the server kills it.

:::moniker-end

:::moniker range=">=azure-pipelines-2022"

retryCountOnTaskFailure string.
Number of retries if the task fails.

:::moniker-end

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