Skip to content

Commit

Permalink
Release documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Kris Healy committed Apr 23, 2015
1 parent 9f0dd41 commit 11131d2
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
51 changes: 51 additions & 0 deletions releasing.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion src/main/java/com/kissmetrics/sdk/Connection.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 11131d2

Please sign in to comment.