From 11131d21d178d305cc7c575da5b45e3a90753eea Mon Sep 17 00:00:00 2001 From: Kris Healy Date: Thu, 23 Apr 2015 09:33:42 -0700 Subject: [PATCH] Release documentation --- releasing.md | 51 +++++++++++++++++++ .../java/com/kissmetrics/sdk/Connection.java | 2 +- 2 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 releasing.md diff --git a/releasing.md b/releasing.md new file mode 100644 index 0000000..90c5ce1 --- /dev/null +++ b/releasing.md @@ -0,0 +1,51 @@ +# Releasing + +### 1. Make sure the tests run + +An important step many may forget: + +```sh +gradle connectedAndroidTest +``` + +You will need an Android emulator running to run the tests. + +### 2. Bump Version Number + +The version number needs to be increased. If it is a feature addition/change +bump the second number (i.e. 2.X.0). If it is a patch/bug fix bump the last +number (i.e. 2.0.X). + +In the `build.gradle` file also bump the `versionCode` number by 1. This is an +Android thing. + +The version number lives in: + + 1. `Connection.java` under `com.kissmetrics.sdk`. It's in the constant `USER_AGENT` + 2. `build.gradle` file at the root. + +### 3. Merge and Tag + +Get your changes into the `master` branch. Then create a tag with the version: + +### 4. Build Artifacts + +You can build everything you need with this command line and Gradle 2.3+: + +```sh +gradle clean build compileReleaseSources javadocs javadocsJar sourcesJar +``` + +It will create the following files: + +``` +build/libs/KISSmetricsSDK-javadoc.jar +build/libs/KISSmetricsSDK-sources.jar +build/libs/KISSmetricsSDK.jar +build/outputs/aar/KISSmetricsSDK-debug.aar +build/outputs/aar/KISSmetricsSDK-release.aar +``` + +### 5. Release + +Create the Release on GitHub. diff --git a/src/main/java/com/kissmetrics/sdk/Connection.java b/src/main/java/com/kissmetrics/sdk/Connection.java index fa5876e..46a2588 100644 --- a/src/main/java/com/kissmetrics/sdk/Connection.java +++ b/src/main/java/com/kissmetrics/sdk/Connection.java @@ -21,7 +21,7 @@ * Connection interface */ interface Connection { - public static final String USER_AGENT = "KISSmetrics-Android/2.2.1"; + public static final String USER_AGENT = "KISSmetrics-Android/2.2.2"; /** * Makes a request to the provided API query urlString.