Skip to content

Commit c19da59

Browse files
author
Josh Deffibaugh
committed
Updates readme
1 parent c7c66d6 commit c19da59

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# optimizely-ab-android-sdk
2-
[![Build Status](https://travis-ci.com/optimizely/optimizely-ab-android-sdk.svg?token=gwpzBrYRAoACxHs4ThQT&branch=master)](https://travis-ci.com/optimizely/optimizely-ab-android-sdk)
2+
Master<br/>
3+
[![Master Status](https://travis-ci.com/optimizely/optimizely-ab-android-sdk.svg?token=gwpzBrYRAoACxHs4ThQT&branch=master)](https://travis-ci.com/optimizely/optimizely-ab-android-sdk)
4+
<br/>
5+
Beta<br/>
6+
[![Beta Status](https://travis-ci.com/optimizely/optimizely-ab-android-sdk.svg?token=gwpzBrYRAoACxHs4ThQT&branch=beta)](https://travis-ci.com/optimizely/optimizely-ab-android-sdk)
7+
<br/>
8+
Devel<br/>
9+
[![Devel Status](https://travis-ci.com/optimizely/optimizely-ab-android-sdk.svg?token=gwpzBrYRAoACxHs4ThQT&branch=devel)](https://travis-ci.com/optimizely/optimizely-ab-android-sdk)
10+
<br/>
11+
<br/>
312
[![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0)
413

514
## Architecture
@@ -61,3 +70,15 @@ Android Studio is an IDE that wraps gradle (and `adb`). Everything you can do i
6170
You can import this project into Android Studio by opening Android Studio and selecting `Import Project` from the first dialog or from the `File` menu. Simply select the project's root `build.gradle` file and Android Studio will do the rest.
6271

6372
Tests can be run by right clicking the file in the project pane or by clicking the method name in source and selecting run. You will be prompted to create an AVD or connect a device if one isn't connected.
73+
74+
## Releasing
75+
76+
The default branch is devel. Feature branch PRs are automatically made against it. When PRs are reviewed and pass checks they should be squased and merged into devel. The version of the SDK in devel should always be the version of the next release plus `-SNAPSHOT`.
77+
78+
If a beta, or snapshot, build needs to be published simply checkout beta and merge devel. The beta branch should fast forward. Push devel and Travis will start. If the tests pass the build will be sent to our Maven repos on Bintray.
79+
80+
When a release version needs to be published checkout the master branch and merge devel. The master branch should be fast forwared. Remove the `-SNAPSHOT` from the version in `build.gradle` and commit directly onto master. Push master and if the tests pass Travis will publish the version to our Maven repos on Bintray. if the version already exists on Bintray the upload will be rejected. The commit that updates the version should also be tagged with the version number.
81+
82+
Once the next release has been published from the master branch the snapshot version in devel should be bumped to the next targeted version.
83+
84+
*Note* only Optimizely employees can push to master, beta, and devel branches.

0 commit comments

Comments
 (0)