OpenKeychain

WARNING: This software is no longer actively developed. We will still apply security fixes where reported, and do basic maintenance work, but no new features or will be worked on. We will try to consider and merge contributions where possible. Branches The development of OpenKeychain happens in the "master" branch. For every release a new branch, e.g., "3.2-fixes" is created to backport fixes from "master" 1. Lookout for interesting issues on Github. We have tagged issues were we explicitly like to see contributions: 2. Read this README, especially the notes about coding style 3. Fork OpenKeychain and contribute code (the best part :sunglasses: ) 4. Open a pull request on Github. We will help with occurring problems and merge your changes back into the main project. 5. PROFIT 1. Join the development mailinglist at 2. Propose bigger changes and discuss the consequences I am happy about every code contribution and appreciate your effort to help us developing OpenKeychain! 1. Clone the project from GitHub 2. Get all external submodules with git submodule update --init --recursive 3. Have Android SDK "tools", "platform-tools", and "build-tools" directories in your PATH ( 4. Open the Android SDK Manager (shell command: android ). Expand the Tools directory and select "Android SDK Build-tools (Version 27.0.3)". Expand the Extras directory and install "Android Support Library", as well as "Local Maven repository for Support Libraries" Select SDK Platform for API levels 27. 5. Export ANDROID HOME pointing to your Android SDK 6. Execute ./gradlew assembleDebug 7. You can install the app with adb install -r OpenKeychain/build/outputs/apk/OpenKeychain-debug.apk Run Tests 1. Use OpenJDK instead of Oracle JDK 2. Execute ./gradlew clean testDebugUnitTest --continue Run Jacoco Test Coverage 1. Use OpenJDK instead of Oracle JDK 2. Execute ./gradlew clean testDebugUnitTest jacocoTestReport 3. Report is here: OpenKeychain/build/reports/jacoco/jacocoTestReport/html/index.html We are using the newest Android Studio for development. Development with Eclipse is currently not possible because we are using the new project structure. 1. Clone the project from Github 2. Get all external submodules with git submodule update --init --recursive 3. From Android Studio: File - Import Project - Select the cloned top folder OpenKeychain uses a forked version with some small changes. These changes will been sent to Bouncy Castle. Update Gradle version Always use a fixed Android Gradle plugin version not a dynamic one, e.g. 0.7.3 instead of 0.7.+ (allows offline builds without lookups for new versions, also some minor Android plugin versions had serious issues, i.e. 0.7.2 and 0.8.1) Update every build.gradle file with the new gradle version and/or gradle plugin version build.gradle OpenKeychain/build.gradle run ./gradlew wrapper twice to update gradle and download the new gradle jar file commit the corresponding Gradle wrapper to the repository (allows easy building for new contributors without the need to install the required Gradle version using a package manager) Update SDK and Build Tools Change SDK and Build Tools in git submodules "openkeychain-api-lib" and "openpgp-api-lib" manually. They should also build on their own without the ext variables. Update library You can check for library updates with ./gradlew dependencyUpdates -Drevision=release Add new library You can add the library as a Maven dependency or as a git submodule (if patches are required) in the "extern" folder. You can get all transitive dependencies with ./gradlew -q dependencies OpenKeychain:dependencies If added as a git submodule, change the compileSdkVersion in build.gradle to use the variables from the root project: You can check for wrong compileSdkVersion by find -name build.gradle xargs grep compileSdkVersion Gradle project dependencies are missing. Do a git submodule init && git submodule update Linux 1. Paste the tools/checkstyle.xml file to ~/.AndroidStudioPrev