mirror of
https://github.com/home-assistant/android
synced 2024-07-21 02:15:07 +00:00
ad64855220
* First attempt at CI action * Split lints and test steps. * Only run validate job on PR. * First attempt at beta deploy via Github Actions * Try to archive a debug version of application. * Use static version of NDK. * Add ENV variables to building the release. * Ensure all secrets are used! * Attempt to publish feature branch. * Make sure all files are in place first. * Ensure keystore is still accessible during deployment. * Update README.md for the lack of automation for now.
64 lines
3.5 KiB
Markdown
64 lines
3.5 KiB
Markdown
# :iphone: Home Assistant Companion for Android [](https://travis-ci.com/home-assistant/home-assistant-android)
|
|
|
|
## Documentation
|
|
If you are looking for documentation around the companion applications check out the [Home Assistant Companion Documentation](https://companion.home-assistant.io/). This will provide you instructions on using the applications.
|
|
|
|
## Setup App Development Environment
|
|
|
|
- Download and install [Android Studio](https://developer.android.com/studio)
|
|
|
|
- Download / clone this repository to a folder on your computer
|
|
|
|
- Create a Firebase project at [Firebase Console](https://console.firebase.google.com)
|
|
|
|
- Create two Android apps, one with `io.homeassistant.companion.android` and one with `io.homeassistant.companion.android.debug` as package name
|
|
|
|
- Now download the `google-services.json` file and put it in the _home-assistant-Android/app_ folder
|
|
|
|
[You can also use the mock services file instead of generating your own](/.github/mock-google-services.json)
|
|
The file should contain client IDs for `io.homeassistant.companion.android` and `io.homeassistant.companion.android.debug` for debugging to work properly. **If you do not generate your own file push notification will never work**
|
|
|
|
- Start Android Studio, open your source code folder and check if the Gradle build will be successful
|
|
|
|
- If the build is successful, you can run the app by doing the following: click **Run** -> **Run 'app'**
|
|
|
|
- Connect your phone or create a new virtual device following on screen instruction
|
|
|
|
- :tada:
|
|
|
|
If you get stuck while setting up your own environment, you can ask questions in the **#devs_mobile_apps** channel on [Discord](https://discord.gg/c5DvZ4e).
|
|
|
|
### Push Notifications
|
|
If you want to work on push notifications or use a development build with push notifications please go the server side code [HERE](https://github.com/home-assistant/mobile-apps-fcm-push) and deploy it to your firebase project. Once you have your androidV1 URL to the deployed service, exchange that for your local builds [PUSH_URL](https://github.com/home-assistant/android/blob/master/data/src/main/java/io/homeassistant/companion/android/data/integration/IntegrationRepositoryImpl.kt#L42).
|
|
|
|
## Testing Dev Releases
|
|
|
|
We are using [Travis](https://travis-ci.com/home-assistant/home-assistant-android) to perform continuous integration both by unit testing, deploying dev releases to [Play Store Beta](https://play.google.com/apps/testing/io.homeassistant.companion.android) and final releases to the [Play Store](https://play.google.com/store/apps/details?id=io.homeassistant.companion.android) when we release.
|
|
|
|
## Quality
|
|
|
|
We are using [ktlint](https://ktlint.github.io/) as our linter.
|
|
You can run a check locally on your machine with:
|
|
```bash
|
|
./gradlew ktlintCheck
|
|
```
|
|
This commands runs on our CI to check if your PR passes all tests. So we strongly recommend running it before committing.
|
|
|
|
To run a check with an auto-format:
|
|
```bash
|
|
./gradlew ktlintFormat
|
|
```
|
|
|
|
## Translating
|
|
The project currently uses [lokalise](https://lokalise.com/public/145814835dd655bc5ab0d0.36753359/) to translate the application. If you are interested in helping translate go to the link and click start translating!
|
|
|
|
|
|
## Generating a release to production
|
|
Update Config.kt with new Version:
|
|
```kotlin
|
|
const val version = "X.X.X"
|
|
```
|
|
Add release in Github, then log into play store and promote beta to production.
|
|
|
|
Automation TBD after changes to Github Actions
|