Variables
Substitution Rule
Variable can be inserted into various fields of project build spec by surrounding with @. The list of available variables will be prompted when @ is typed. Below is some examples of variable substitutions (assume project name is foobar):
Original | Substitued | Explanation |
|---|---|---|
| ubuntu-@project_name@ | ubuntu-foobar | contents enclosed with @ is variable and will be substituted |
| ubuntu-@@project_name@@ | ubuntu-@project_name@ | @@ will be interpreted as literal @ |
| ubuntu-@project_name@@ | OneDev will complain about invalid variable reference | @project_name@ will be interpreted as a variable reference, and the last @ is singled out. The correct form should either be ubuntu-@project_name@@@, or ubuntu-@project_name@@someOtherVar@ |
Variable Reference
Variable | Explanation |
|---|---|
| project_name | name of current project |
| project_path | path of current project |
| job_name | name of current job |
| ref | git ref the job is running against. For instance:
|
| branch | git branch this job is running against. This variable will be empty if job is not running against a branch |
| tag | git tag this job is running against. This variable will be empty if job is not running against a tag |
| commit_hash | git commit hash this job is running against |
| build_number | serial number of generated build which can be used to reference the build |
| build_version | version of generated build specified via step Set Build Version |
| pull_request_number | serial number of the pull request triggering the job as result of pull request open/update |
| param:<parameter name> | value of specified job parameter spec |
| property:<property name> | value of specified build spec property |
| script:builtin:<script name> | run specified builtin groovy script and get the result |
| script:<script name> | run specified custom groovy script and get the result |