Skip to content

Latest commit

 

History

History
113 lines (88 loc) · 4.31 KB

BUILDING.md

File metadata and controls

113 lines (88 loc) · 4.31 KB
Raw

How To Build SMSSync app

This is a Gradle based project. You can build it using Android Studio or from the command line. To do so follow the steps below:

  1. Install the following software: - Android SDK: http://developer.android.com/sdk/index.html - Android Studio - Optional: http://developer.android.com/sdk/installing/studio.html

  2. Run the Android SDK Manager by pressing the SDK Manager toolbar button in Android Studio or by running the 'android' command in a terminal window.

  3. In the Android SDK Manager, ensure that the following are installed, and are updated to the latest available version: - Tools -> Android SDK Platform-tools (rev 20 or above) - Tools -> Android SDK Tools (rev 23.0.2 or above) - Tools -> Android SDK Build-tools version 20 - Tools -> Android SDK Build-tools version 19.1 - Android 4.4 -> SDK Platform (API 8) at least - Android L (API 22) - Extras -> Android Support Repository - Extras -> Android Support Library - Extras -> Google Play services - Extras -> Google Repository

  4. Create a file in the root of the project called local.properties. Enter the path to your Android SDK. Eg. sdk.dir=/opt/android-studio/sdk

  5. Import the project in Android Studio:

    1. Press File > Import Project
    2. Navigate to and choose the settings.gradle file in this project
    3. Press OK

How To Build SMSSync website

Preview website

The SMSSync website hosted on github pages is generated using hugo. Please refer to the hugo's installation guide on how to get it running.

$ cd website-src

$ hugo server -w

You then preview the site at http://localhost:1313

Release checklist

These are guidelines to follow when you're about to make a release.

Prepare

  • Set release date and notify relevant stakeholders.
  • Write changelog.
    • Make sure the relevant play store release info has been updated. Look inside play/en-US folder. Usually you update this with the changelog entries for the version to be released.
    • Make sure changelog.json is updated and it validates. Use jsonlint to validate the file.
  • Request for design asset if needed.
  • Draft a release announcement.
  • Make sure documentation on the website is updated to reflect any feature additions or changes in the release.
  • Make a local preview of the website to make sure nothing is broken. Refer to How To Build SMSSync website above.

Release

  • Increase the 'versionCode' number in smssync/build.gradle
  • Issue the ./release.sh command to make a release. This command has automated a lot of the release process.
  • Attach the release APK to the release tag on github. In the future this will be automated.

Release Build

To make a release make sure you have gradle.properties in the root of smssync folder with the following content.

gradle.properties

releaseKeyStore=<key_store_file>
releaseKeyPassword=<key_password>
releaseKeyStorePassword=<key_store_password>
releaseKeyAlias=key_alias
googleDocsForm=<link_to_google_docs_feedback_form>
gPlaystoreServiceAccountEmailAddress=<playstore_service_account_email>
gPlaystorePKFile=<google-playstore-pk-file.p12>
inAppPurchasePubKey=<In-app_purchase_public_key>
googleAnalyticsCode=<google-analytics-code>

A typical gradle.properties content should look like this:

releaseKeyStore=/home/username/.android/debug.keystore
releaseKeyStorePassword=android
releaseKeyAlias=androiddebugkey
releaseKeyPassword=android
googleDocsForm="https://docs.google.com/forms/d/1lL/formResponse"
gPlaystoreServiceAccountEmailAddress=9323892392132-842jajdkdadummy@developer.gserviceaccount.com
gPlaystorePKFile=/home/username/pdummy-pk-file.p12
inAppPurchasePubKey=MIDKDLSkdakidkkse8283-23jjkasdk
googleAnalyticsCode=UA-1234567890

Then in the project's root directory, issue:

./release major milestone alpha

This should build the app, version it, create a tag and push it to the remote repo and publish it to the Google Playstore's alpha track.

Note: always update the relevant stage and track for the release. Issue ./release to know more about the valid options for the release command.