Set Variable
Name
A friendly name for this action (will be displayed in the actions workflow area).
Enabled
Determines if this action will be run within the relevant stage.
Variable
This drop down contains a list of Configuration, Project and Application variables accessible to the configuration. See Variables for details on how to create a variable. Note that Expression variables cannot be modified and are therefore not listed.
Operation
You can choose to run one of the following operations on the variable:
- Replace: The variable's value will be overwritten with the new value.
- Append or increment: For Text type variables, the new value will be appended to the old value. For Numeric type variable values the old value will be incremented by the new value. DateTime/Date/Time variables cannot be incremented or appended to. Not you can decrement Numeric type variables by using negative number as the new value.
- Replace using a regular expression: This allows you to overwrite parts of the variable's old value which match a regular expression pattern.
New Value
The new value of the variable used for Replace and "Append or increment" operations.
Note: Any date time variable values should be entered as UTC. Full date time format is: yyyy-MM-dd'T'HH:mm:ss'Z' e.g. 2099-12-31T23:59:59Z
Expand variable references in new value
If this option is ticked, then the New Value will be expanded (if there's any expressions in it) before it is used to replace, append, or increment the variable's value.
Pattern
Available for the "Replace using a regular expression" operation. A regular expression pattern to match against the existing value of the variable.
Replace With
Available for the "Replace using a regular expression" operation. This text will used to replace regular expression matches in the variable's value. This may contain back references to captured groups in the regular expression pattern, see Substitutions in Regular Expressions. Note these need to be escaped e.g. $1 => $$1 if expanding.
Expand variable references in replacement value
If this option is ticked, then the Replace With will be expanded (if there's any expressions in it) before it is used to replace regular expression matches in the variable's value.
Set
This drop down contains a list of variable types that this action can set:
- Build variable: This is the default option. Build variables inherit the value of the configuration, project or application variable at the start of the build. Changes to the build variable, either manually entered into the Queue Options prompt or set by actions such as this one are specific to the current build. Build variables are not accessible by other builds.
- Server variable: .
- Server variable and overwrite build variable with result: This allows you to overwrite parts of the variable's old value which match a regular expression pattern.
------
Note: When a variable is set during a build, it is copied from the Configuration variables namespace and stored in Build variable namespace. This means you can still reference the variable's original value by using %Configuration.MyVariable%. Otherwise, to use the updated value, simply reference the variable by its name %MyVariable%.
Operation
You can choose to replace a variable's value or append/increment it. If you choose to append/increment then it takes in the value type of the variable.
For text/expression type variables the new value will be appended to the old value.
For numeric type variable values the old value will be incremented by the new value.
New Value
The new value of the variable.
Note: Any date time variable values should be entered as UTC. Full date time format is: yyyy-MM-dd'T'HH:mm:ss'Z' e.g. 2099-12-31T23:59:59Z
Expand variable references in new value
If you select this option then the value will be expanded (if there's any expressions in it) when the variable is used and the new value will be set to it.