Bamboo 3.1 Upgrade Guide
The instructions on this page describe how to upgrade to Bamboo 3.1 from a previous version of Bamboo. For details on the Bamboo 3.1 release, see the Bamboo 3.1 Release Notes.
Please follow the Bamboo 3.1-specific instructions on this page, in addition to the upgrade instructions in the Bamboo upgrade guide.
Please read the Supported platforms page for the full list of supported platforms for Bamboo.
Bamboo Compatibility with Subversion pre-1.6
We have changed the default behavior of the SVNKit library in Bamboo. As a result, any source code checked out by Bamboo will be automatically upgraded to be compatible with Subversion 1.6. This does not adversely affect any pre-1.6 Subversion servers. However, if you use a pre-1.6 Subversion client to access code checked out by Bamboo, then any Bamboo builds on that code may fail.
If you want to prevent any checked out code from being automatically upgraded to SVN client format 1.6, you will need to run Bamboo with the following system property:
For more information, please see this FAQ: Setting Bamboo to support Subversion 1.7 Workspace Format
End of Support for Java Platform 5 (JDK/JRE 1.5)
We are ending support for Java Platform 5 (JDK/JRE 1.5) in this release. Please see End of support announcements for Bamboo for further details.
Conversion of Builders to Tasks
The introduction of the Tasks feature in Bamboo 3.1 means that the following activities will occur during the upgrade to Bamboo 3.1:
- Builder capabilities will be renamed to Executable capabilities.
- Builders will be converted to Tasks. The Tasks will be linked to the Job that the Builders were a part of.
- If one of your Builders cannot be matched to a Task (e.g. you are using a custom plugin), it will be converted to a 'Compatibility Task'. The configuration for your Builder will be transferred to this Task, and the Task will be linked to the Job that the Builder was a part of. You can view/update the configuration by navigating to the Task and clicking 'Configure Legacy Executable'.
Changes to Bamboo Files/Directories for Bamboo distributions for Windows
If you are using the Bamboo distribution (not EAR-WAR) for Windows, please note that the location of the following files/directories have changed.
- All log files now located at
%USERPROFILE%\bamboo.log, rather than in the logs folder of your installation directory. For Bamboo running as a Windows service, log files are located at
%WINDIR%\System32\Config\systemprofile\bamboo.log. Note, existing logs will not be migrated, however new logs will be written to the new location when running Bamboo after the upgrade.
- All temporary directories on windows are now by default in
%WINDIR%\Temp, rather than in the user's temporary directory.
Gravatar Support Enabled by Default
The new Gravatar support feature is enabled by default in Bamboo 3.1. For more information, see Configuring Gravatar support.
Upgrading from Bamboo 3.0 to 3.1
Before you begin, do the following:
1. Back up your existing installation of Bamboo
We strongly recommend that you do the following to back up your Bamboo installation:
- Back up your xml-data directory — See the Bamboo upgrade guide for instructions.
- Export your Bamboo data for backup — See the Exporting data for backup for instructions. Please note, that this may take a long time to complete depending on the number of builds and tests in your system.
2. Ensure that your plugins work
If you are using plugins, ensure that your plugins are compiled against 3.1 before upgrading.
Before you upgrade, please read the following important points that relate to Bamboo 3.0.
Upgrading from Bamboo prior to 3.0
In addition to the notes below, please read the Upgrade Guide for every version you are skipping during the upgrade.
Notes for upgrading from Bamboo 2.6.x
- You will need to upgrade to Bamboo 2.7.4 before upgrading to Bamboo 3.0. If you are not running Bamboo 2.6.3, we recommend that you upgrade to it before upgrading to Bamboo 2.7.4. Bamboo 2.6.3 can be downloaded from the Bamboo Archived Downloads page. Bamboo 2.7.x introduces a number of significant and irreversible changes, so a phased upgrade is recommended. Please see the Bamboo 2.7.x Upgrade Guide for more details.
- You will need to set aside time, as described in the Bamboo 2.7.x Upgrade Guide, for Bamboo to migrate existing Plans to the new Plan structure in Bamboo 2.7.4.
Notes for upgrading from Bamboo 2.5 or earlier
- If you are upgrading from Bamboo 2.5 or earlier, you will need to set aside time, as described in the Bamboo 2.6 Upgrade Guide for Bamboo to migrate its test result data (stored in XML files on the filesystem) into the database.
Notes for upgrading from a version of Bamboo prior to 2.0
- If you are upgrading from a version of Bamboo prior to 2.0, you must upgrade to Bamboo 2.0.6 first before upgrading to Bamboo 2.6. Please read the Bamboo 2.0 Upgrade Guide for important upgrade instructions for upgrading from earlier versions of Bamboo.
Developing for Bamboo 3.1
If you are a Bamboo plugin developer, please refer to our Changes for Bamboo 3.1 guide, which outlines changes in Bamboo 3.1 that may affect Bamboo plugins compiled for Bamboo version 3.0.x or earlier.
Checking for Known Issues and Troubleshooting the Bamboo Upgrade
If something is not working correctly after you have completed the steps above to upgrade your Bamboo installation, please check for known Bamboo issues and try troubleshooting your upgrade as described below:
- Check for known issues. Sometimes we find out about a problem with the latest version of Bamboo after we have released the software. In such cases we publish information about the known issues in the Bamboo Knowledge Base. Please check the Bamboo 3.1 Known Issues in the Bamboo Knowledge Base and follow the instructions to apply any necessary patches if necessary.
- Did you encounter a problem during the Bamboo upgrade? Please refer to the guide to troubleshooting upgrades in the Bamboo Knowledge Base.
- If you encounter a problem during the upgrade and cannot solve it, please create a support ticket and one of our support engineers will help you.