Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 2.73 KB

FOR_MAINTAINERS.md

File metadata and controls

42 lines (27 loc) · 2.73 KB
Raw

Particle Android: Maintainer Info

This document is intended for mobile app maintainers at Particle.

Publishing Our Libraries

Background

Our libraries, like the Cloud SDK and Device Setup lib, are published to JCenter using a pair of plugins located at the root of the repo, pom_generator_v1.gradle, and bintray_upload_v1.gradle. At some point, these plugins should probably be replaced by the built-in support for Maven publishing coming to the Android Gradle plugin in version 3.6.

Preparation

There are a few prerequisite steps for publishing updates to our libs:

  1. Get a Bintray account on Bintray.com.
  2. Join the Particle org on Bintray by going to this page and clicking the "Join" button.
  3. Get your Bintray API key by visiting your profile page, and clicking on the API Key section on the left.
  4. Create a file called bintray_user_auth_secrets.properties in the parent folder of your API root. (The file is located there to prevent Bintray secrets from accidentally being committed to the repo.) The file should look contain two keys, bintray.user and bintray.apikey. It should look like the following:
bintray.user=your_bintray_username
bintray.apikey=0123456789abcdef0123456789abcdef01234567

Making releases

See RELEASING.md at the root of the repo.

Publishing App Updates

Preparation

  1. Make your Particle GSuite account into a Google Play developer account via the usual process.
  2. Get your Google Play developer account added as an admin on the Google Play Console for the Tinker app. Ask in the #mobile or #engineering Slack channels, or just ask your manager to find out who can help you with this.
  3. Get your Particle GSuite account added to the Firebase console. (Whomever adds you to the Play Console should be able to do this, too.)
  4. Download the Google Services JSON file and put it in app/google-services.json. This file should not be added to git, and is in the repo's .gitignore, since it contains API keys and other things which shouldn't be made public.
  5. Download the app signing keystore from the Engineering password vault and store it somewhere outside of the repo.
  6. Download the oauth_client_creds.xml file from our private mobile assets repository, and put it in app/src/main/res/values/oauth_client_creds.xml. Since it contains OAuth secrets, this file is also part of the repo's .gitignore.

Making releases

See RELEASING.md at the root of the repo.