On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

This page describes how to configure a Bamboo task to run a script. The Script task is flexible enough to allow the possibility to use: the default shells on Linux (/bin/sh) or Windows (cmd.exe), a more modern shell on Windows (Powershell), and an arbitrary shell in Linux by using the shebang on the first line of the script file. This can be controlled by the Interpreter field explained below.

To configure a script task:

  1. Go to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
  2. Select the name of the desired script task, or select Add taskScript if creating a new task.
  3. Complete the following settings:

    Task description
    A description of the task, which is displayed in Bamboo.

    Disable this task
    Check or clear to selectively run this task.

    Add condition to task
    Make task run only when a certain condition is met. 
    You can find conditions on Atlassian Marketplace or implement your own.  

    Make sure to use the syntax appropriate for the interpreter of your choice. You can select from the following interpreters:

    • Shell
      This option selects the interpreter based on the first line of the script, typically using the shebang.
    • Windows PowerShell
      This option uses the Powershell on Windows.
    • /bin/sh or cmd.exe
      This option uses the default shell of the operating system (sh for Linux, cmd.exe for Windows).

    Script location
    Select the location of the script file.

    • File — enter the location of the file in the Script file field. This can be either relative to the repository root of the plan, or absolute. You can include variables (see Bamboo variables).
    • Inline — enter the script in the Script body field.

    Specify an argument to pass to the script. Arguments that contain spaces must be quoted. You can include variables (see Bamboo variables).

  4. If required, specify environment variables and working directory settings:

    Environment variables (Optional) 
    Additional system environment variables that you want to pass to your build. Note that existing environment variables are automatically available to the executable. You can also include Bamboo global or build-specific variables (see Bamboo variables).
    Multiple variables should be separated with spaces. Parameters with spaces must be quoted (e.g ANT_OPTS="-Xms200m -Xmx700m").

    Working subdirectory (Optional) 
    An alternative subdirectory, relative to the job's root directory, where Bamboo will run the executable. The root directory contains everything checked out from the job's configured source repository. If you leave this field blank, Bamboo will look for build files in the root directory. This option is useful if your task has a build script in a subdirectory and the executable needs to be run from within that subdirectory.

  5. Select Save.

Script task type configuration screen

Last modified on Dec 15, 2021

Was this helpful?

Provide feedback about this article
Powered by Confluence and Scroll Viewport.