| Div | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
On this page
|
Examples
Table plus
Some common fields are handled with specific CLI parameters
| CLI Field | POST Field |
|---|---|
| plan | planKey |
| taskKey | createTaskKey |
| description | userDescription |
| disable | taskDisabled=true |
Source checkout
| POST Field | Example POST Value | Discussion |
|---|---|---|
| createTaskKey | com.atlassian.bamboo.plugins.vcs%3Atask.vcs.checkout | Task keys are in the form xxx:yyy. Use : in place of %3A. taskKey: com.atlassian.bamboo.plugins.vcs:task.vcs.checkout |
| selectedRepository_0 | defaultRepository | Says to use the default repository for the plan. Default should just use the default as well. |
| cleanCheckout | true | Defaults to false. |
| checkoutDir_0 | You must set it to blank or a specific value (otherwise you will get an NullPointerException). |
| Code Block |
|---|
-a addTask --plan XX-XX --job JOB1 --taskKey com.atlassian.bamboo.plugins.vcs:task.vcs.checkout --description "get source" --disable --field1 selectedRepository_0 --value1 defaultRepository --field2 cleanCheckout --value2 true --field3 checkoutDir_0 --value3 "" |
Script
| POST Field | Example POST Value | Discussion |
|---|---|---|
| createTaskKey | com.atlassian.bamboo.plugins.scripttask%3Atask.builder.script | Task keys are in the form xxx:yyy. Use : in place of %3A. taskKey: com.atlassian.bamboo.plugins.scripttask:task.builder.script |
| scriptlocation | INLINE | INLINE or FILE. |
| scriptBody | exit -1 | Body for INLINE scripts. Use " \n " for new lines (leading and trailing blanks are significant. |
| script | myscript.sh | File for FILE scripts. |
| argument | Command line arguments. Defaults to blank. | |
| environmentVariables | Environment variables. Defaults to blank. | |
| workingSubDirectory | Working subdirectory. Defaults to blank. | |
| runWithPowershell | true | Defaults to false. |
| Code Block |
|---|
-a addTask --plan XX-XX --job JOB1 --taskKey com.atlassian.bamboo.plugins.scripttask:task.builder.script --field1 scriptlocation --value1 INLINE --field2 scriptBody --value2 "exit -1" |
Maven
| POST Field | Example POST Value | Discussion |
|---|---|---|
| createTaskKey | com.atlassian.bamboo.plugins.maven%3Atask.builder.mvn2 | Task keys are in the form xxx:yyy. Use : in place of %3A. taskKey: com.atlassian.bamboo.plugins.maven:task.builder.mvn2 |
| label | Maven 2 | Executable label of type Maven 2. |
| buildJdk | JDK | Build JDK. |
| environmentVariables | Environment variables. Defaults to blank. | |
| workingSubDirectory | Working subdirectory. Defaults to blank. | |
| testChecked | true | Defaults to false. |
| testDirectoryOption | standardTestDirectory | Defaults to standardTestDirectory. Alternate is customTestDirectory. |
| testResultsDirectory | Defaults to **/target/surefire-reports/*.xml. | |
| projectFile | Defaults to blank. |
| Code Block |
|---|
-a addTask --plan XX-XX --job JOB1 --description "Simple" --taskKey com.atlassian.bamboo.plugins.maven:task.builder.mvn2 --field1 label --value1 "Maven 2" --field2 goal --value2 "compile" --field3 buildJdk --value3 JDK |
Groovy
Gradle
Gradle Wrapper
Gant
| POST Field | Example POST Value | Discussion |
|---|---|---|
| createTaskKey | org.swift.bamboo.groovy%3Agroovy | Task keys are in the form xxx:yyy. Use : in place of %3A. taskKeys:
|
| label | Groovy | Executable label like Groovy, Gradle, Gradle Wrapper, or Gant. |
| scriptLocation | FILE | INLINE or FILE. |
| script | my-script.groovy | Script location for FILE. |
| scriptBody | INLINE script. Use " \n " for new lines (leading and trailing blanks are significant. | |
| buildJdk | JDK | Build JDK. |
| environmentVariables | Environment variables. Defaults to blank | |
| workingSubDirectory | Working subdirectory. Defaults to blank. | |
| testChecked | true | Defaults to false. |
| testDirectoryOption | standardTestDirectory | Defaults to standardTestDirectory. Alternate is customTestDirectory. |
| testResultsDirectory | Defaults to **/target/surefire-reports/*.xml. |
| Code Block |
|---|
-a addTask --plan XX-XX --job JOB1 --description "Simple" --taskKey org.swift.bamboo.groovy:groovy --field1 label --value1 "Groovy" --field2 scriptLocation --value2 FILE --field3 script --value3 my-script.groovy --field4 buildJdk --value4 JDK |
GINT
| POST Field | Example POST Value | Discussion |
|---|---|---|
| createTaskKey | org.swift.bamboo.groovy%3Agint | Task keys are in the form xxx:yyy. Use : in place of %3A. taskKey: org.swift.bamboo.groovy:gint |
| label | Gant | Executable label referencing a Gant executable. |
| scriptLocation | FILE | INLINE or FILE. |
| script | integration-test.gant | Script location for FILE. |
| scriptBody | INLINE script. Use " \n " for new lines (leading and trailing blanks are significant. | |
| targets | Specific targets to run. Defaults to blank. | |
| levelAll | true | Include all integer levels. Equivalent to command line -Dlevel=all. Defaults to false. |
| includeLevelsAll | true | Include all named levels. Equivalent to command line -DincludeLevels=all. Defaults to false. |
| clean | true | Ignore previous run state, run tearDown and setUp. Equivalent to command line -Dclean. Defaults to false. |
| verbose | true | Log additional information. Equivalent to command line -Dverbose. Defaults to false. |
| stopOnFail | Stop running more testcases once a testcase fails. Equivalent to command line -DstopOnFail. Defaults to false. | |
| propertyLocation | FILE | INLINE or FILE. |
| propertyFile | | Property location for FILE. |
| propertyBody | INLINE script. | |
| buildJdk | JDK | Build JDK. |
| environmentVariables | Environment variables. Defaults to blank. | |
| workingSubDirectory | Working subdirectory. Defaults to blank. | |
| testChecked | true | Defaults to false. |
| testDirectoryOption | standardTestDirectory | Defaults to standardTestDirectory. Alternate is customTestDirectory. |
| testResultsDirectory | Defaults to **/*reports/*.xml. |
| Code Block |
|---|
-a addTask --plan XX-XX --job JOB1 --description "Integration test" --taskKey org.swift.bamboo.groovy:gint --field1 label --value1 "Gant" --field2 scriptLocation --value2 FILE --field3 script --value3 integration-test.gant --field4 buildJdk --value4 JDK --fields levelAll:true,includeLevelsAll:true,clean:true,verbose:true,stopOnFail:false,testChecked:true |
CLI
| POST Field | Example POST Value | Discussion |
|---|---|---|
| createTaskKey | org.swift.bamboo.acli%3Ajira | Task keys are in the form xxx:yyy. Use : in place of %3A. taskKeys:
|
| scriptLocation | FILE | INLINE or FILE. |
| script | create-jira-issue.txt | Script location for FILE. |
| scriptBody | --action ... | INLINE script. Use " \n " for new lines (leading and trailing blanks are significant. |
| Include Page | ||||
|---|---|---|---|---|
|