feat(cli): setup Android signing

tauri-apps · Jun 4, 2024 · 8acfa34 · 8acfa34
1 parent f955f7b
commit 8acfa34
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 1 deletion.
diff --git a/.changes/android-signing.md b/.changes/android-signing.md
@@ -0,0 +1,6 @@
+---
+"tauri-cli": patch:feat
+"@tauri-apps/cli": patch:feat
+---
+
+Setup Android signing by reading the `src-tauri/gen/android/keystore.properties` file which should have the `keyAlias=<key-alias>`, `password=<keystore-password>`, `storeFile=<path/to/keystore.jks>` key value pairs separated by new lines.
diff --git a/tooling/cli/templates/mobile/android/.gitignore b/tooling/cli/templates/mobile/android/.gitignore
@@ -16,4 +16,6 @@ local.properties
 key.properties
 
 /.tauri
-/tauri.settings.gradle
+/tauri.settings.gradle
+
+keystore.properties
diff --git a/tooling/cli/templates/mobile/android/app/build.gradle.kts b/tooling/cli/templates/mobile/android/app/build.gradle.kts
@@ -1,4 +1,5 @@
 import java.util.Properties
+import java.io.FileInputStream
 
 plugins {
     id("com.android.application")
@@ -8,6 +9,15 @@ plugins {
     id("{{this}}"){{/each}}
 }
 
+val keystoreProperties = Properties()
+try {
+  // release builds require the file to be set up
+  keystoreProperties.load(FileInputStream(rootProject.file("keystore.properties")))
+} catch (e: Exception) {
+  // load a dummy file for debug purposes (signing config won't be used)
+  keystoreProperties.load(FileInputStream(rootProject.file("keystore.properties.dummy")))
+}
+
 val tauriProperties = Properties().apply {
     val propFile = file("tauri.properties")
     if (propFile.exists()) {
@@ -26,6 +36,14 @@ android {
         versionCode = tauriProperties.getProperty("tauri.android.versionCode", "1").toInt()
         versionName = tauriProperties.getProperty("tauri.android.versionName", "1.0")
     }
+    signingConfigs {
+        create("release") {
+            keyAlias = keystoreProperties["keyAlias"] as String
+            keyPassword = keystoreProperties["password"] as String
+            storeFile = file(keystoreProperties["storeFile"] as String)
+            storePassword = keystoreProperties["password"] as String
+        }
+    }
     buildTypes {
         getByName("debug") {
             manifestPlaceholders["usesCleartextTraffic"] = "true"
@@ -45,6 +63,7 @@ android {
                     .plus(getDefaultProguardFile("proguard-android-optimize.txt"))
                     .toList().toTypedArray()
             )
+            signingConfig = signingConfigs.getByName("release")
         }
     }
     kotlinOptions {

diff --git a/tooling/cli/templates/mobile/android/keystore.properties.dummy b/tooling/cli/templates/mobile/android/keystore.properties.dummy
@@ -0,0 +1,3 @@
+keyAlias=tauri-dummy
+password=dummy-pwd
+storeFile=./dummy-keystore.jks