How to use HockeyApp with Bamboo

This how-to describes how to use HockeyApp together with Bamboo. Bamboo is a server for automated building, testing, deploying, and releasing of your software.

Prerequisites

1. We assume that you have Bamboo 3.3 installed. The HockeyApp plugin does not run with older versions of Bamboo.

2. If you want to use Bamboo with iOS apps, you should have already configured the Xcode plugin for your app.

3. You will need your HockeyApp API token later in the process. If you haven't already, go here and create an API token for your app or a generic token. Please note that if you choose "Upload Only", the API token will allow the upload of a new app version, but not to set its status.

Install Plugin

1. Download the latest version of the HockeyApp Bamboo Plugin.

2. Open Bamboo in your browser, sign in with an Admin accont, then select "Administation" in the top navigation.

3. Select "Plugin Manager" in the sidebar (it's in the section "Plugins").

4. Select the tab "Install" and click on "Upload Plugin".

   

5. Select "Choose File", search for the downloaded file and press "Upload". (At our machine, the upload window remained open forever, but a reload in the browser showed the plugin anyway.)

6. Select "Manage Existing" to check if the HockeyApp plugin was successfully installed.

Add Tasks

1. Select your plan, then open the "Actions" menu and choose "Configure Plan".

2. Select your job (default should be "Default Job").

3. Select the tab "Tasks".

4. The purpose of the first task is to zip the .dSYM file after the build process has finished. You can skip this and jump to step 11 if you do not want to use the crash reporting feature or doing this tutorial for an Android app.

5. Click on "Add Task".

6. Select the "Command" task.

   

7. Click on "Add New Executable". Enter "zip" as the label and "/usr/bin/zip" as the path. Confirm with "Add".

   

8. Fill out the field "Argument" as follows and replace YOUR_APP with the executable name of your app:

    -r YOUR_APP.dSYM.zip YOUR_APP.app.dSYM
   

9. Fill out the field "Working Sub Directory" as follows:

    build/Release-iphoneos/
   

10. Click on "Save".

    

11. The next task uploads your binary to HockeyApp.

12. Click on "Add Task".

13. Select "Deployment" in the sidebar, then choose the "HockeyApp" task.

    

14. Fill out the field "API Token" with your API token.

15. Fill out the field ".ipa or .apk File" with the relative path to your .ipa or .apk file. If you are using the Xcode task, the path should be like this (replace YOUR_APP with the executable name of your app):

    build/Release-iphoneos/YOUR_APP.ipa
    

16. Fill out the field ".dSYM.zip File" with the relative path to your .dSYM.zip file (or skip this step). If you have added the first task as described above, the path should be like this (replace YOUR_APP with the executable name of your app):

    build/Release-iphoneos/YOUR_APP.dSYM.zip
    

17. Add release notes and set the checkboxes as required.

18. Click on "Save".

    

You can now run your plan by clicking on "Run Plan". The HockeyApp task outputs the API token and the upload progress in 10% steps to the log. If the upload fails, you should find the response JSON there as well and the job should be marked in red.