Versions Compared

Version Old Version 2 New Version 3
Changes made by

George Swinnerton

George Swinnerton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Leave all these as they are.

Step 7 - Variables

??? - to be returned to.Leave this as it is.

(TODO: Check if we have any examples where we use this...)

Step 8 - Miscellaneous / Audit Log

Leave these as they are.

Step 9 - Job(s)

Select the Default Job from the left hand side of the page. All our build plans (so far) only use a single job.

Step 10 - Source Code Checkout

This step checks out your code to the build directory of the server, along with the housekeeping scripts that will be used by other steps.


  • There should be a Task called "Source Code Checkout". Click on this and see that it is set to checkout the Default Repository which should be your project.
  • Click on the "Add Repository" button at the bottom of the screen and choose the housekeeping repository. Enter housekeeping as the checkout folder.
  • Click Save.

Step 11 - Script Task (Tox)

This step runs Tox which performs a number of tasks such as running unit tests and returning their output in a standard way. (TODO: Link to Tox documentation once written...)


  • Click on the "Add Task" button and search for a "Script" task. Click OK.
  • In the Task Description enter "Run Tox".
  • As this is a Linux task put "Shell" as the Interpreter.
  • For the script location Select "File" and put "housekeeping/scripts/linux/runtests.sh" as the script location.
  • Click Save

Step 12 - Script Task (Build Pip)

This step runs a script which builds the code and uploads it to the Dev pip repository. This then allows it to easily be installed on other computers.

  • Click on the "Add Task" button and search for a "Script" task. Click "OK".
  • In the Task Description enter "Build PIP"
  • Again, as this is a Linux task put "Shell" as the Interpreter.
  • For the script location Select "File" and put "housekeeping/scripts/linux/build_wheel.sh" as the script location.
  • In the Argument field put "dev my_package", where my_package is the name of the package to be built. Dev is the index to which it will be published.
  • Click Save

Step 13 - Junit Parser Task

This step takes the XML output produced by any tests that have run and parses it into a format that Bamboo can understand.

  • Click on the "Add Task" button and search for the "Junit Parser" task. Click OK.
  • In the Task Description enter "Parse Reports"
  • The custom results directory should already be set to "**/test-reports/*.xml" - if so leave as-is.
  • Click Save
  • Drag the "Junit Parser" Task down to the "Final Tasks" section. This is so that it runs even if there has been a problem with the previous steps.

Step 14 - Requirements

  • Click on the "Requirements" Tab.
  • As this is a Linux job choose "Linux Python3.6" and "exists", then "Add". This should change the "Number of Agents this job can build on" from 2 to 1 as you have restricted it to running on the Linux server.

Step 15 - Artifacts

Artifacts are files that have been produced as part of the build process that you wish to make available via the Bamboo website. This may include code coverage reports or zipped builds of the code.

Step 16 - Miscellaneous

You should be able to leave this as-is. Setting it to clean the build directory is sometimes useful if you are having issues with your Python virtualenv containing incorrect package versions but it will noticably slow down the build process.