Variable replacements
Variable | Replacement | Since |
---|---|---|
branch | Last created or referenced branch | 10.0 |
commit | Last referenced commit id | 10.0 |
commitMessage | Last referenced commit message | 10.0 |
deployment | Last referenced deployment key | 10.0 |
deploymentName | Last referenced deployment name | 10.0 |
deploymentUuid | Last referenced deployment UUID | 10.0 |
pullRequest | Last referenced pull request id | 10.0 |
pullRequestName | Last referenced pull request name (title) | 10.0 |
project | Last created or referenced project key | 9.3 |
projectUuid | Last created or referenced project UUID | 9.3 |
projectName | Last created or referenced project name | 9.3 |
pipeline | Last started or referenced pipeline number | 10.0 |
pipelineState | Last referenced pipeline state | 10.0 |
pipelineResult | Last referenced pipeline result | 10.0 |
pipelineUrl | Last referenced pipeline URL | 10.3 |
pipelineUuid | Last referenced pipeline UUID | 10.2 |
pipelineCache | Last referenced pipeline cache name | 10.4 |
pipelineCacheUuid | Last referenced pipeline cache UUID | 10.4 |
pipelineCacheUrl | Last referenced pipeline cache archive URL | 10.4 |
stepName | Last referenced pipeline step name | 10.4 |
stepUuid | Last referenced pipeline step UUID | 10.4 |
stepState | Last referenced pipeline state | 10.4 |
stepResult | Last referenced pipeline result | 10.4 |
runner | Last reference runner name | 10.0 |
runnerUuid | Last reference runner uuid | 10.0 |
runnerType | Last reference runner type | 11.1 |
runnerLabels | Last reference runner labels | 10.0 |
runnerOauthClientId | Last reference runner oath client id | 11.1 |
runnerOauthClientSecret | Last added runner oauth client secret
| 11.1 |
repository | Last referenced repository key | 10.0 |
repositoryFullKey | Last referenced repository full key | 10.0 |
repositoryName | Last referenced repository name | 10.0 |
repositoryUuid | Last referenced repository UUID | 10.0 |
userId | Last referenced user name | 10.0 |
userKey | Last referenced user key | 10.0 |
userDisplayName | Last referenced user display name | 10.0 |
userUuid | Last referenced user UUID | 10.0 |
workspace | Last referenced workspace key | 10.0 |
workspaceName | Last referenced workspace name | 10.0 |
workspaceUuid | Last referenced workspace UUID | 10.0 |
Common Client Variables
Variable | Replacement | Since |
---|---|---|
entry | Entry being processed from the list parameter of the runFromList action | |
entry2 | Entry being processed from the list2 parameter of the runFromList action | |
renderRequest | Last result from the renderRequest action modified by findReplace processing | |
server | Server URL available for clients accessing a remote server | 9.0 |
hosting | Available with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values | 9.3 |
version | Available with getServerInfo for clients accessing a remote server | 9.3 |
runDate | For run action scripts, it is the client date at the time of the first action referencing the value
| 9.0 |
file | File path name for last get or get list action that used the file parameter | 9.3 |
fileSize | File size for the last get or get list action that used the file parameter | 9.3 |
fileContent | File text content for the last get or get list action that used the file parameter
| 9.3 |
More information
- The syntax is @<variable>@. See How to use replacement variables for more details.
- Variable names are case-sensitive!
- Action help and document lists variables set by specific actions.
- Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
- Last created means the variable is set from the last create or add action.
- Referenced means the variable is set from one of the runFrom or get actions.
- Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
- Within a run script, the setReplacementVariableList action can be used to set custom variables.
- Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
- Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.
Log a request with our support team.
Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.