0
0
mirror of https://github.com/ankidroid/Anki-Android.git synced 2024-09-20 20:03:05 +02:00
Anki-Android/AnkiDroid/build.gradle
David Allison b3a138035b feat: App Introduction System
A screen which appears on the first run of the application

Displaying:
* Get Started
* Sync from AnkiWeb

This aims to handle the use case of an existing user.
If they do not sync immediately, then they risk creating
two collections, which are incompatible and cause a sync conflict

Based on 9130 by Shridhar Goel
2022-08-26 23:39:35 -05:00

354 lines
17 KiB
Groovy

plugins {
// Gradle plugin portal
id 'com.github.triplet.play' version '3.7.0'
}
apply plugin: 'com.android.application'
apply plugin: 'app.brant.amazonappstorepublisher'
apply plugin: 'idea'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-parcelize'
repositories {
google()
mavenCentral()
maven { url "https://jitpack.io" }
}
idea {
module {
downloadJavadoc = System.getenv("CI") != "true"
downloadSources = System.getenv("CI") != "true"
}
}
def homePath = System.properties['user.home']
android {
compileSdkVersion 32 // change api compileSdkVersion at the same time
defaultConfig {
applicationId "com.ichi2.anki"
buildConfigField "Boolean", "CI", (System.getenv("CI") == "true").toString()
buildConfigField "Boolean", "LEGACY_SCHEMA", "true"
buildConfigField "String", "ACRA_URL", '"https://ankidroid.org/acra/report"'
buildConfigField "String", "BACKEND_VERSION", "\"$ankidroid_backend_version\""
// The version number is of the form:
// <major>.<minor>.<maintenance>[dev|alpha<build>|beta<build>|]
// The <build> is only present for alpha and beta releases (e.g., 2.0.4alpha2 or 2.0.4beta4), developer builds do
// not have a build number (e.g., 2.0.4dev) and official releases only have three components (e.g., 2.0.4).
//
// The version code is derived from the version name as follows:
// AbbCCtDD
// A: 1-digit decimal number representing the major version
// bb: 2-digit decimal number representing the minor version
// CC: 2-digit decimal number representing the maintenance version
// t: 1-digit decimal number representing the type of the build
// 0: developer build
// 1: alpha release
// 2: beta release
// 3: public release
// DD: 2-digit decimal number representing the build
// 00 for internal builds and public releases
// alpha/beta build number for alpha/beta releases
//
// This ensures the correct ordering between the various types of releases (dev < alpha < beta < release) which is
// needed for upgrades to be offered correctly.
versionCode=21600181
versionName="2.16alpha81"
minSdkVersion 21
//noinspection OldTargetApi - also performed in api/build.fradle
targetSdkVersion 29 // change .travis.yml platform download at same time
testApplicationId "com.ichi2.anki.tests"
vectorDrawables.useSupportLibrary = true
testInstrumentationRunner 'com.ichi2.testutils.NewCollectionPathTestRunner'
}
signingConfigs {
release {
storeFile file("${homePath}/src/android-keystore")
keyAlias "nrkeystorealias"
storePassword System.getenv("KSTOREPWD")
keyPassword System.getenv("KEYPWD")
}
}
buildTypes {
debug {
debuggable true
splits.abi.universalApk = true // Build universal APK for debug always
// Check Crash Reports page on developer wiki for info on ACRA testing
// buildConfigField "String", "ACRA_URL", '"https://918f7f55-f238-436c-b34f-c8b5f1331fe5-bluemix.cloudant.com/acra-ankidroid/_design/acra-storage/_update/report"'
if (project.rootProject.file('local.properties').exists()) {
Properties localProperties = new Properties()
localProperties.load(project.rootProject.file('local.properties').newDataInputStream())
// #6009 Allow optional disabling of JaCoCo for general build (assembleDebug).
// jacocoDebug task was slow, hung, and wasn't required unless I wanted coverage
testCoverageEnabled localProperties['enable_coverage'] != "false"
// not profiled: optimization for build times
if (localProperties['enable_languages'] == "false") {
android.defaultConfig.resConfigs "en"
}
// allow overriding default schema version
if (localProperties["legacy_schema"] != null) {
buildConfigField "Boolean", "LEGACY_SCHEMA", localProperties["legacy_schema"]
}
} else {
testCoverageEnabled true
}
// make the icon red if in debug mode
resValue 'color', 'anki_foreground_icon_color_0', "#FFFF0000"
resValue 'color', 'anki_foreground_icon_color_1', "#FFFF0000"
}
release {
minifyEnabled true
splits.abi.universalApk = universalApkEnabled // Build universal APK for release with `-Duniversal-apk=true`
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.release
resValue 'color', 'anki_foreground_icon_color_0', "#FF29B6F6"
resValue 'color', 'anki_foreground_icon_color_1', "#FF0288D1"
}
}
/**
* Product Flavors are used for Amazon App Store and Google Play Store.
* This is because we cannot use Camera Permissions in Amazon App Store (for FireTv etc...)
* Therefore, different AndroidManifest for Camera Permissions is used in Amazon flavor.
*/
flavorDimensions "appStore"
productFlavors {
play {
dimension "appStore"
}
amazon {
dimension "appStore"
}
}
/**
* Set this to true to create five separate APKs instead of one:
* - 2 APKs that only work on ARM/ARM64 devices
* - 2 APKs that only works on x86/x86_64 devices
* - a universal APK that works on all devices
* The advantage is the size of most APKs is reduced by about 2.5MB.
* Upload all the APKs to the Play Store and people will download
* the correct one based on the CPU architecture of their device.
*/
def enableSeparateBuildPerCPUArchitecture = true
splits {
abi {
reset()
enable enableSeparateBuildPerCPUArchitecture
//universalApk enableUniversalApk // set in debug + release config blocks above
include "armeabi-v7a", "x86", "arm64-v8a", "x86_64"
}
}
// applicationVariants are e.g. debug, release
applicationVariants.all { variant ->
// We want the same version stream for all ABIs in debug but for release we can split them
if (variant.buildType.name == 'release') {
variant.outputs.all { output ->
// For each separate APK per architecture, set a unique version code as described here:
// https://developer.android.com/studio/build/configure-apk-splits.html
def versionCodes = ["armeabi-v7a": 1, "x86": 2, "arm64-v8a": 3, "x86_64": 4]
def outputFile = output.outputFile
if (outputFile != null && outputFile.name.endsWith('.apk')) {
def abi = output.getFilter("ABI")
if (abi != null) { // null for the universal-debug, universal-release variants
// From: https://developer.android.com/studio/publish/versioning#appversioning
// "Warning: The greatest value Google Play allows for versionCode is 2100000000"
// AnkiDroid versionCodes have a budget 8 digits (through AnkiDroid 9)
// This style does ABI version code ranges with the 9th digit as 0-4.
// This consumes ~20% of the version range space, w/50 years of versioning at our major-version pace
output.versionCodeOverride =
// ex: 321200106 = 3 * 100000000 + 21200106
versionCodes.get(abi) * 100000000 + defaultConfig.versionCode
}
}
}
}
}
testOptions {
animationsDisabled true
}
compileOptions {
coreLibraryDesugaringEnabled true
}
packagingOptions {
exclude 'META-INF/DEPENDENCIES'
}
ndkVersion "22.0.7026061"
}
play {
serviceAccountCredentials.set(file("${homePath}/src/AnkiDroid-GCP-Publish-Credentials.json"))
track.set('alpha')
}
amazon {
securityProfile = file("${homePath}/src/AnkiDroid-Amazon-Publish-Security-Profile.json")
applicationId = "amzn1.devportal.mobileapp.524a424d314931494c55383833305539"
pathToApks = [ file("./build/outputs/apk/amazon/release/AnkiDroid-amazon-universal-release.apk") ]
replaceEdit = true
}
// Install Git pre-commit hook for Ktlint
task installGitHook(type: Copy) {
from new File(rootProject.rootDir, 'pre-commit')
into { new File(rootProject.rootDir, '.git/hooks') }
fileMode 0755
}
tasks.getByPath(':AnkiDroid:preBuild').dependsOn installGitHook
// Issue 11078 - some emulators run, but run zero tests, and still report success
task assertNonzeroAndroidTests() {
doLast {
// androidTest currently creates one .xml file per emulator with aggregate results in this dir
File folder = file("./build/outputs/androidTest-results/connected/flavors/play")
File[] listOfFiles = folder.listFiles({ d, f -> f ==~ /.*.xml/ } as FilenameFilter)
for (File file : listOfFiles) {
// The aggregate results file currently contains a line with this pattern holding test count
String[] matches = file.readLines().findAll { it.contains('<testsuite') }
if (matches.length != 1) {
throw new GradleScriptException("Unable to determine count of tests executed for " + file.name + ". Regex pattern out of date?", null)
}
if (!(matches[0] ==~ /.* tests="\d+" .*/) || matches[0].contains('tests="0"')) {
throw new GradleScriptException("androidTest executed 0 tests for " + file.name + " - Probably a bug with the emulator. Try another image.", null)
}
}
}
}
afterEvaluate {
tasks.getByPath(':AnkiDroid:connectedPlayDebugAndroidTest').finalizedBy(assertNonzeroAndroidTests)
}
apply from: "./robolectricDownloader.gradle"
apply from: "./jacoco.gradle"
apply from: "../lint.gradle"
dependencies {
configurations.all {
resolutionStrategy {
force 'org.jetbrains:annotations:23.0.0'
}
}
lintChecks project(":lint-rules")
coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.6'
compileOnly 'org.jetbrains:annotations:23.0.0'
compileOnly "com.google.auto.service:auto-service-annotations:1.0.1"
annotationProcessor "com.google.auto.service:auto-service:1.0.1"
implementation 'androidx.activity:activity-ktx:1.5.1'
implementation 'androidx.annotation:annotation:1.4.0'
implementation 'androidx.appcompat:appcompat:1.4.2'
implementation 'androidx.browser:browser:1.4.0'
implementation "androidx.core:core-ktx:1.8.0"
implementation 'androidx.exifinterface:exifinterface:1.3.3'
implementation "androidx.fragment:fragment-ktx:$fragments_version"
implementation "androidx.preference:preference-ktx:1.2.0"
implementation 'androidx.recyclerview:recyclerview:1.2.1'
implementation 'androidx.sqlite:sqlite-framework:2.2.0'
implementation 'androidx.swiperefreshlayout:swiperefreshlayout:1.1.0'
implementation 'androidx.viewpager2:viewpager2:1.0.0'
// noinspection GradleDependency - pinned at 1.12 until API26 minSdkVersion (File.toPath usage)
implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
implementation 'androidx.webkit:webkit:1.5.0'
// Note: the design support library can be quite buggy, so test everything thoroughly before updating it
implementation 'com.google.android.material:material:1.6.1'
implementation 'com.fasterxml.jackson.core:jackson-databind:2.13.3'
implementation 'com.github.CanHub:Android-Image-Cropper:4.3.1'
implementation 'org.nanohttpd:nanohttpd:2.3.1'
// Backend libraries
implementation 'com.google.protobuf:protobuf-kotlin:3.21.5' // This is required when loading from a file
Properties localProperties = new Properties()
if (project.rootProject.file('local.properties').exists()) {
localProperties.load(project.rootProject.file('local.properties').newDataInputStream())
}
if (localProperties['local_backend'] == "true") {
implementation files("../../Anki-Android-Backend/rsdroid/build/outputs/aar/rsdroid-release.aar")
testImplementation files("../../Anki-Android-Backend/rsdroid-testing/build/libs/rsdroid-testing-${ankidroid_backend_version}.jar")
// On Windows, you can use something like
// implementation files("C:\\GitHub\\Rust-Test\\rsdroid\\build\\outputs\\aar\\rsdroid-release.aar")
} else {
implementation "io.github.david-allison-1:anki-android-backend:$ankidroid_backend_version"
testImplementation "io.github.david-allison-1:anki-android-backend-testing:$ankidroid_backend_version"
}
// A path for a testing library which provide Parameterized Test
testImplementation "org.junit.jupiter:junit-jupiter:$junit_version"
testImplementation "org.junit.jupiter:junit-jupiter-params:$junit_version"
// May need a resolution strategy for support libs to our versions
implementation "ch.acra:acra-http:$acra_version"
implementation "ch.acra:acra-dialog:$acra_version"
implementation "ch.acra:acra-toast:$acra_version"
implementation "ch.acra:acra-limiter:$acra_version"
implementation 'com.afollestad.material-dialogs:core:3.3.0'
implementation 'com.afollestad.material-dialogs:input:3.3.0'
// io.github.java-diff-utils:java-diff-utils is the natural successor here, but requires API24, #7091
implementation 'org.bitbucket.cowwoc:diff-match-patch:1.2'
// noinspection GradleDependency - commons-compress 1.12 - later versions use `File.toPath`; API26 can remove?
implementation 'org.apache.commons:commons-compress:1.12' // #6419 - handle >2GB apkg files
implementation 'org.apache.commons:commons-collections4:4.4' // SetUniqueList
implementation 'commons-io:commons-io:2.11.0' // FileUtils.contentEquals
implementation 'net.mikehardy:google-analytics-java7:2.0.13'
implementation 'com.squareup.okhttp3:okhttp:4.10.0'
implementation 'com.arcao:slf4j-timber:3.1'
implementation 'com.jakewharton.timber:timber:5.0.1'
implementation 'org.jsoup:jsoup:1.15.3'
implementation "com.github.zafarkhaja:java-semver:0.9.0" // For AnkiDroid JS API Versioning
implementation 'com.drakeet.drawer:drawer:1.0.3'
implementation 'uk.co.samuelwall:material-tap-target-prompt:3.3.2'
implementation 'com.github.mrudultora:Colorpicker:1.2.0'
implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
implementation "org.jetbrains.kotlin:kotlin-test:$kotlin_version"
implementation 'com.github.ByteHamster:SearchPreference:v2.2.1'
implementation 'com.github.AppIntro:AppIntro:6.1.0'
// Cannot use debugImplementation since classes need to be imported in AnkiDroidApp
// and there's no no-op version for release build. Usage has been disabled for release
// build via AnkiDroidApp.
implementation 'com.squareup.leakcanary:leakcanary-android:2.9.1'
api project(":api")
testImplementation "org.junit.vintage:junit-vintage-engine:$junit_version"
testImplementation 'org.mockito:mockito-inline:4.7.0'
testImplementation "org.mockito.kotlin:mockito-kotlin:4.0.0"
testImplementation "org.hamcrest:hamcrest:$hamcrest_version"
testImplementation 'net.lachlanmckee:timber-junit-rule:1.0.1'
// robolectricDownloader.gradle *may* need a new SDK jar entry if they release one or if we change targetSdk. Instructions in that gradle file.
testImplementation "org.robolectric:robolectric:4.8.2"
testImplementation 'androidx.test:core:1.4.0'
testImplementation 'androidx.test.ext:junit:1.1.3'
testImplementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
testImplementation "org.jetbrains.kotlin:kotlin-test:$kotlin_version"
testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:$coroutines_version"
testImplementation "io.mockk:mockk:1.12.7"
testImplementation 'org.apache.commons:commons-exec:1.3' // obtaining the OS
// debugImplementation required vs testImplementation: https://issuetracker.google.com/issues/128612536
debugImplementation "androidx.fragment:fragment-testing:$fragments_version"
// May need a resolution strategy for support libs to our versions
androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
androidTestImplementation('androidx.test.espresso:espresso-contrib:3.4.0') {
exclude module: "protobuf-lite"
}
androidTestImplementation 'androidx.test.ext:junit:1.1.3'
androidTestImplementation 'androidx.test:rules:1.4.0'
androidTestImplementation "org.jetbrains.kotlin:kotlin-test:$kotlin_version"
}
apply from: "./kotlinMigration.gradle"