ProtonMail for Android

Copyright (c) 2021 Proton Technologies AG

Build instructions

• Install android sdk
• Clone this repository (Use git clone --recurse-submodules [url].).
• Execute ./gradlew assembleDebug, open and build in Android Studio or use fastlane as defined below to build

CI / CD

CI stages are defined in the .gitlab-ci.yml file and we rely on fastlane to implement most of them. Fastlane can be installed and used locally by performing

bundle install

(requires Ruby and bundler to be available locally)

bundle exec fastlane lanes

will show all the possible actions that are available.

Master is continuously deployed

Each merge to master branch builds the branch's HEAD and deploy it to firebase app distribution In order to someone as a tester for such builds, their email address needs to be added to the v6-dev-builds-testers group in Firebase.

Observability

Crashes and errors that happen in release (non debuggable) builds are reported to Sentry in an anonymised form. The CI sets up the integration with Sentry by providing in the build environment a private.properties file that contains the secrets needed. This can as well be performed locally by creating a private.properties file (which will be ignored by git) and filling it with the needed secrets (eg. SentryDSN)

UI Tests

UI tests are executed on firebase through the CI. Firebase test lab can be triggered also locally with bundle exec fastlane uiTests or tests can be run in a local emulator through android studio. The app/src/uiTest/assets/users.json file will be needed for UI tests to work, its value can be found on the CI

Code style

This project's code style and formatting is checked by detekt. The rule set is ktlint's default one

License

The code and datafiles in this distribution are licensed under the terms of the GPLv3 as published by the Free Software Foundation. See https://www.gnu.org/licenses/ for a copy of this license.