https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
Build-specific variables
Build-specific variable | Description | Availablity |
|---|---|---|
bamboo.buildKey | The job key for the current job, in the form PROJECT-PLAN-JOB, e.g. | |
bamboo.planKey | The key of the current plan, in the form PROJECT-PLAN, e.g. | |
bamboo.shortPlanKey | The short key of the current plan (without project part), e.g. | |
bamboo.shortJobKey | The short key of the current job (without project and plan parts), e.g. | |
bamboo.buildResultKey | The result key when this job executes, in the form PROJECT-PLAN-JOB-BUILD e.g. | |
bamboo.buildResultsUrl or bamboo.resultsUrl | The URL of the result in Bamboo once the job has finished executing. | |
bamboo.buildNumber | The Bamboo build number, e.g. | |
bamboo.buildPlanName | The Bamboo job name e.g. | |
bamboo.planName | The current plan's name e.g. | |
bamboo.shortPlanName | The current plan's name without project part, e.g. | |
bamboo.shortJobName | The current job's name without project and plan parts, e.g. | |
bamboo.buildTimeStamp | The time when build was started in ISO 8601 format e.g. | |
bamboo.agentId | The ID of the agent that the deployment is executed on. | |
bamboo.agentWorkingDirectory | The path to the working directory on the agent, for example The agent working directory is not the same as the build working directory described below. | |
bamboo.build.working.directory | The working directory on which the build is being executed, for example | |
bamboo.ManualBuildTriggerReason.userName | The user who triggered the manual build. | |
Generic repository variables | ||
bamboo.planRepository.<position>.branchName | The name of the branch in the repository (depends on availability from the VCS used) e.g. | |
bamboo.planRepository.<position>.name | The name of of the repository, as shown in the repository for the plan e.g. Mercurial | |
bamboo.planRepository.<position>.revision | The revision use to build this release. Format depends on the VCS used. | |
bamboo.planRepository.<position>.previousRevision | The previous revision number (this might not exist, for example for the initial build). | |
bamboo.planRepository.<position>.type | The type of the repository, as defined by a repository plugin e.g. hg, svn, git | |
bamboo.repository.pr.key | Pull request key if plan branch was created from pull request | |
bamboo.repository.pr.sourceBranch | Pull request source branch name if plan branch was created from pull request | |
bamboo.repository.pr.targetBranch | Pull request destination branch name if plan branch was created from pull request | |
Subversion | ||
bamboo.planRepository.<position>.username | User name, used for repository authentication. | |
bamboo.planRepository.<position>.repositoryUrl | The repository URL. | |
CVS | ||
bamboo.planRepository.<position>.last.update.time | The last updated timestamp. | |
bamboo.planRepository.<position>.last.update.time.label | The last updated timestamp to be used as a label for post build result labeling. The spaces in the cvs version string are replaced with '_'. | |
Perforce | ||
bamboo.planRepository.<position>.revision.number | The change set number. | |
bamboo.planRepository.<position>.username | User name, used for repository authentication. | |
bamboo.planRepository.<position>.port | Port used for repository communication. | |
bamboo.planRepository.<position>.client | Client used for repository communication. | |
Git | ||
bamboo.planRepository.<position>.branch | The branch | |
bamboo.planRepository.<position>.repositoryUrl | The repository URL | |
Mercurial | ||
bamboo.planRepository.<position>.repositoryUrl | The repository URL | |
bamboo.planRepository.<position>.branch | The branch | |
bamboo.planRepository.<position>.username | User name, used for repository authentication. |
Build dependency variables
Build-specific variable | Description |
|---|---|
bamboo.dependency.parent.# | Allows a child build to query the build key of the triggering parent build, where # represents the position in the build tree - 0 at the top, 1 the following, and so on. The ${bamboo.dependency.parent.0} variable can be viewed in the child plan's metadata tab. |
bamboo.dependency.parent.total | The total # of parent builds. |
Deployment Variables
Variable | Description | Availablity |
|---|---|---|
bamboo.agentId | The id of the agent that the deployment is executed on. | ⛔ |
bamboo.agentWorkingDirectory | The path to the working directory on the agent. This is not the same as the Bamboo working directory. | ⛔ |
bamboo.build.working.directory | The path to the working directory for Bamboo. This is used by both the build plan and the deployment project. | ⛔ |
bamboo.deploy.environment | The name of the environment that the release is to be deployed to. |
|
bamboo.deploy.project | The name of the deployment project. |
|
bamboo.deploy.rollback | True if the release being deployed is older than the release being replaced. |
|
bamboo.deploy.release bamboo.deploy.version | The name of the release that is being deployed. Either .release or .version can be used - both return the name of the release being deployed. |
|
bamboo.deploy.release.previous bamboo.deploy.version.previous | The name of the release that is being replaced (if available). Either .release or .version can be used - both return the name of the release being replaced. |
|
bamboo.resultsUrl | The URL to the screen in Bamboo that dispays build results. | ⛔ |
Releases variables
Variable | Description |
|---|---|
bamboo.buildNumber | The build result from which the release is created. |
bamboo.buildResultKey | The key of the build result from which the release is created e.g. KUNG-FOO-35 |
bamboo.planKey | The key of the plan related to the release e.g. KUNG-FOO |
bamboo.planName | The name of the plan related to the release e.g. Kung - Foo |
bamboo.shortPlanKey | The short key of the plan related to the release (without project part), e.g. |
bamboo.shortPlanName | The plan's name without project part, e.g. |
System variables
The usage format for all system variables is:
${system.<variable>}
Jira applications variables
Note that these variables can be accessed from a Bamboo build only when that build was triggered by releasing a version in Jira Software Server.
Jira variable | Description |
|---|---|
${bamboo.jira.baseUrl} | The URL of your Jira application server. |
${bamboo.jira.projectKey} | The key of the triggering Jira application project. |
${bamboo.jira.projectName} | The name of the triggering Jira application project. |
${bamboo.jira.version} | The release version of the triggering Jira application project. |
${bamboo.jira.username} | The username of the user who triggered the release build. |