Using global, plan or build-specific variables

${bamboo.globalVarName}

Plan variables

See Defining plan variables for information on defining plan variables. You can override a plan variable for a build, if you have triggered the build manually. For details, see Triggering a plan build manually.

The usage format for all plan variables is:

${bamboo.varName}

Build-specific variables

The following build-specific variables are available by default:

• System variables also apply across your entire Bamboo instance and inherit their values from system or environment variables of the same name.

The usage format for all build-specific variables is:

${bamboo.varName}

JIRA variables

Note that these JIRA variables can be accessed from a Bamboo build only when that build was triggered by releasing a version in JIRA.

System variables

The usage format for all system variables is:

${system.<variable>}

For example, if you have a system variable MYPATH=C:\MyPath; you can use a Bamboo system variable system.MYPATH which will inherit the same value as the system variable.

In older Bamboo versions using 'PATH' in the Environment Variables field (of a Script task) doesn't set the windows PATH variable, whereas using 'Path' sets Path and PATH in cmd shell.

Using variables in bash

Bamboo variables are exported as bash shell variables. The name is converted to upper case and all full stops (periods) are converted to underscores. For example, the variable bamboo.my.variable is $BAMBOO_MY_VARIABLE in bash.

Using variables

Variables can be used in the following fields of your build plan:

Field	Global	Build-specific	System
Goal (for Maven builders only) — see Configuring tasks
Build File (for Ant and NAnt builders only) — see Configuring tasks
Target (for Ant and NAnt builders only) — see Configuring tasks
Options (for NAnt builders only) — see Configuring tasks
Script (for Scripts only) — see Configuring tasks
Argument (for Scripts and Custom Commands only) — see Configuring tasks
Environment Variables — see Configuring tasks
Repository URL (for Subversion repositories only) — see Specifying the source repository
Web Repository URL (for Subversion, CVS and Perforce repositories) — see Specifying the source repository
CVS Root (for CVS repositories only) — see Specifying the source repository
Branch name (for CVS repositories only) — see Specifying the source repository

Maven examples

For example, you may want your Maven 2 version to be determined by Bamboo. In Maven 2 pom.xml you may have:

...
<groupId>com.atlassian.boo</groupId>
<artifactId>boo-test</artifactId>
<packaging>jar</packaging>
<version>1.1.${bambooBuildNumber}-SNAPSHOT</version>
...

You can then specify the following in the Goal field of your build plan:

clean package -DbambooBuildNumber=${bamboo.buildNumber}

When the command runs, Bamboo will replace the buildNumber with the actual number (e.g. 1102), which will be passed to the underlying Maven build to use. The command will then produce a jar that looks like this: boo-test-1.1.1102-SNAPSHOT.jar.

Ant examples

You can then specify the following in the Target field of your build plan:

-f build.xml -DbambooBuildNumber=${bamboo.buildNumber}

When the command runs, Bamboo will replace the buildNumber with the actual number (e.g. 1102), which will be passed to the underlying Ant build to use.

Specifying capabilities as variables

You can also specify a capability to be used in a similar way to a global variable.

The format of the capability should be as follows:

${bamboo.capability.<capability_key>}

For example,

If you click on a capability, the specific capability key will be contained in the URL.

Please note, the space characters in the URL will be replaced with '+' characters. We recommend that you do not use capability labels with space characters, if you wish to use them as variables. A possible solution for space characters is to format them with '${}' symbols, however, this does not work in all cases.

Using capabilities

Global and Build-Specific Variables can be used in a specific fields of your build plan, as specified above. For capabilities,

• System Capabilities are available to all of these fields, (i.e. global and build-specific).
• Agent Capabilities (i.e. agent-specific and shared/server capabilities) are available only to the build-specific fields. (i.e. not available to Repository URL, CVS Root or Branch name.)

For example,