Deploy Script

Introduction

The suripu-android codebase includes a small deploy script to automate creation of HockeyApp builds for internal distribution.

Prerequisites for use

• The Hello-Android-Internal and Hello-Android-Release key stores
• A HockeyApp API key with upload permissions

Setting up your environment for the deploy script

• Install the colorize gem (e.g. [sudo] gem install colorize)
• Add your HockeyApp API key to your environment with the name HELLO_DEPLOY_HOCKEY_TOKEN (e.g. export HELLO_DEPLOY_HOCKEY_TOKEN=xyz)

Available Build Types

alpha

Alpha builds are similar to store builds, but include the following extra features:

• A debug screen accessible through the tapping Sense x.y.z at the bottom of the settings screen
• A small client for communicating with Sense without a user-centric interface (the Piru-pea option in the debug screen)
• Extra options during on-boarding accessible through long pressing the ? button
• Support for arbitrary API environments
• Targets a non-production Mixpanel account.

Alpha builds can be created and uploaded at any time. They are typically only consumed for QA purposes.

store

Store builds include no debug options, and are intended to be released to the public. Store builds can only be created on the master branch.

feature

Feature builds are identical to store builds, but are uploaded to a different distribution channel on HockeyApp. They should be used for work-in-progress builds that require input from design or product.

Flags

• -t / --[no-]tests: Runs the project tests before deploying.
• -k / --[no-]clean: Cleans the project before deploying. Should almost always be used.
• -sTAG / --save-tag=TAG: Creates a tag on the current branch. Required for new releases.