BBAppGradlePlugin

Gradle build plugin for Brandingbrand Android Apps

We have a custom plugin BBAppBuildPlugin that sets up all the tasks and plugin configuration.

Usage

The plugin has the following properties that can be configured

• frameworkVersion The framework version that the client will be using Default value: null

• useMavenVersioning A boolean to indicate if the maven multiplier has to be used while computing the version code. See SetupReleaseVersion task for more info Default value: false

Sample Usage

buildscript {
    repositories {
        mavenCentral()
        repositories {
            maven {
                url "http://nexus.brandingbrand.com/nexus/content/repositories/releases/"
                credentials {
                    username NEXUS_USER
                    password NEXUS_PASSWORD
                }
            }
        }
    }
    dependencies {
        classpath group: 'com.brandingbrand', name: 'BBAppGradlePlugin',
                version: insertVersion
    }
}

apply plugin: 'bbapp'

bbapp {
  frameworkVersion '3.5.7-SNAPSHOT'
  hockeyAppDescription 'Android Stage app'
  useMavenVersioning true
}

Plugins

• The HockeyApp plugin is applied and configured
• The Android plugin is applied

Tasks

The following tasks are available as part of the plugin:

• bumpBuildVersion is used to increment the build version each time a QA build is made. For example, if the current release build is 2.3.1, the qa build would be 2.3.1.1 and next one would be 2.3.1.2 and so on and so forth. The version code is computed based on this versionName. So, there shouldn't ever be a need to update it manually

Sample usage: ./gradlew bumpBuildVersion

• prepareReleaseVersion takes a parameter appVersionName to set the release version and updates the version code accordingly. If no parameter is provided the task makes use of VERSION_CODE to setup the versionName by dropping the build number, (i:e, 3.2.1.1 becomes 3.2.1) and computes the versionCode. This task occurs prior to assembleRelease or installRelease, so it doesn't necessarily have to be explicitly called.

Sample usage: ./gradlew prepareReleaseVersion -PappVersionName=4.3.2 or simply ./gradlew prepareReleaseVersion

• pushVersionToGithub to automatically push changes to gradle.properties whenever a build is uploaded to hockeyapp

Sample usage: ./gradlew pushVersionToGithub Please note, however, that this task typically doesn't have to be called explicitly. It is implicitly invoked everytime a hockeyapp task is executed. But if you would like to skip this task, you can do by using the argument skipPushToGithub - On the command line it would look like: ./gradlew uploadUatToHockeyApp -PskipPushToGithub

• printFrameworkVersion, as the name suggests, prints the name of the current framework version that the client(app) is using. This is run during the configuration phase

Sample usage: ./gradlew printFrameworkVersion

Releasing a new version

• Update the version in build.gradle. For example, if is 1.0, change it to 1.1

• Please make sure you run the following command prior to releasing a new version, to ensure the build isn't failing:

./gradlew clean check

• To upload a new version, the following command would accomplish the upload to the nexus servers:

./gradlew uploadArchives

• After successfully publishing the release, tag the release on Github:

  git tag -a v3.1 -m "Release version 3.1"
  git push v3.1
  

Changelog

See here

Migration from v1.0 to v1.1

• Remove VERSION_CODE_QA and VERSION_CODE_RELEASE from gradle.properties and replace it with VERSION_CODE having the same value
• Replace the variable VERSION_CODE_RELEASE in {appDirectory}/build.gradle with VERSION_CODE

Legacy Tasks - v1.0

• bumpVersionCode assumes that the buildtype is something other than a "release" and simply increments the version code.

Sample usage: ./gradlew bumpVersionCode installUat

• setupReleaseVersion takes a parameter releaseVersionName to set the release version and updates the version code accordingly. This task occurs prior to assembleRelease or installRelease. So it doesn't need to be explicitly called but the parameter has to be set via the command line; otherwise the task is skipped and the version name/code aren't updated. Sample usage: ./gradlew assembleRelease -PreleaseVersionName=4.3.2