How to run a bash script with arguments in azure devops pipeline?

Question

I've a script which works locally fine and while running the script i'm passing 2 arguments in the script and its work perfectly fine, Here's how i'm running the bash script locally:

       ./changeDB_connection.sh "fdevtestcuskv04" "test"

But, I want to do it through azure devops pipeline and for that I've a pipeline task in which I'm calling a bash script with script arguments but it failed with this error message: ##[error]Bash exited with code '1'

Here's the pipeline task:

  - task: Bash@3
    displayName: 'Update Mongo Connection String'   
    condition: and(succeeded(), eq('${{ parameters.UpdateDBstr }}', 'true'))   
    inputs:
      azureSubscription: $(azureSubscription)
      workingDirectory: '$(System.DefaultWorkingDirectory)/Terraform/templates'
      targetType: 'filePath'
      failOnStderr: true
      filePath: "$(System.DefaultWorkingDirectory)/Terraform/Terraform-Scripts/changeDB_connection.sh"
      ScriptArguments: '-keyVaultName $(kvname) -Stringintials $(strinitial)'

let me know what am i doing wrong.

Without access to the script, all we can tell you is what's already in the error message. Perhaps ScriptArguments should be a list, though? — tripleee
– tripleee, Commented Aug 26, 2022 at 12:58
Quick Duck Duck Going gets me learn.microsoft.com/en-us/azure/devops/pipelines/tasks/utility/… which does not mention ScriptArguments at all but this could be the normal state of affairs at Microsoft, of course (you are in a maze of twisty documentation, none of which is accurate, and all of which contradict each other). — tripleee
– tripleee, Commented Aug 26, 2022 at 13:01

emmanuelgws · Accepted Answer · 2022-09-28 20:50:45Z

6

For bash task with multiple arguments you can use YAML multiline syntax e.g.

- task: Bash@3
  inputs:
    targetType: 'filePath'
    filePath: "$(System.DefaultWorkingDirectory)/Terraform/Terraform-Scripts/changeDB_connection.sh"
    arguments: >
        -keyVaultName $(kvname) 
        -Stringintials $(strinitial)

edited Sep 28, 2022 at 20:50

answered Sep 28, 2022 at 20:43

emmanuelgws

893 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Bast · Accepted Answer · 2022-08-29 13:32:24Z

Bowman's answer regarding passing arguments to the script works, but can become troublesome if many arguments should be passed.

I would instead recommend passing arguments as environment variables to the script and then consuming the same variables in the script. This would require some rewriting of your script.

The documentation for the bash task specifies how to pass environment variables to the script-execution. In short, just add them under env in your task definition.

Example:

steps:
- task: Bash@3
  inputs:
    targetType: 'filpath'
    filepath: 'my/file/path'
  env:
    MYFIRSTVARIABLE: 'some text'
    MYSECONDVARIABLE: $(aPipelineVariable)

Consume the envrionment variables in the bash script by referencing $MYFIRSTVARIABLE and $MYSECONDVARIABLE respectively. If the variables are secrets, you should keep them in variable groups which the pipeline consumes.

Bowman Zhu · Accepted Answer · 2022-08-29 06:31:14Z

1

The below is a sample, and it works fine on my side.

xxx.sh

#pass arguments to the script
echo "Argument 1 is $1"
echo "Argument 2 is $2"
echo "Argument 3 is $3"

RunBashScript.yml

trigger:
- none

pool:
  vmImage: ubuntu-latest

steps:
- task: Bash@3
  inputs:
    filePath: 'xxx.sh'
    arguments: '1 2 3'

Successfully on my side:

Structure on my side:

answered Aug 29, 2022 at 6:31

Bowman Zhu

7,5941 gold badge13 silver badges16 bronze badges

Comments

Patrick Byers · Accepted Answer · 2025-07-28 17:05:42Z

1

I was here trying to reference an Azure DevOps parameter (as apposed to a variable) in a bash script step of my Pipeline. My script wasn't in a file; it was defined in the YML itself.

I eventually figured it out: instead of prefixing the reference in a dollar-sign and wrapping in parenthesis like $(), I needed to wrap my parameter reference in double brackets like ${{ }}.

Here is my YML:


parameters:
 - name: name
  displayName: Customer Name
  type: string
  default: ABC
  values:
  - ABC
  - DEF
  - GHI

# ...

    - bash: |
        my_cli --customer ${{ parameters.customer }}

Utilizing bash environment variables didn't seem to work for me, but maybe it could have. See Examples | Bash@3 - Bash v3 task for more on that.

edited Jul 28 at 17:05

answered Jan 3 at 22:00

Patrick Byers

836 bronze badges

Collectives™ on Stack Overflow

How to run a bash script with arguments in azure devops pipeline?

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related