build: configure release pipeline and add flavor dimensions

This commit introduces the following changes:

- Configures the release pipeline in the GitHub Actions workflow to set up the keystore, build release artifacts (APKs and AAB), and rename them with version information.
- Adds "gms" and "standalone" product flavors to `app/build.gradle.kts`.
- Configures signing for release builds using properties from `keystore.properties`.
- Specifies different text recognition dependencies for "gms" and "standalone" flavors.
- Includes a TODO for a future pipeline to release to Google Play.

Author: kid1412621

.github/workflows/release.yml

@@ -92,15 +92,31 @@ jobs:
           echo "Version Name: ${VERSION_NAME}"
           echo "Version Code: ${VERSION_CODE}"
 
+      - name: Setup Keystore
+        env:
+          KEYSTORE_BASE64: ${{ secrets.KEYSTORE_BASE64 }}
+          KEY_ALIAS: ${{ secrets.KEY_ALIAS }}
+          KEY_PASSWORD: ${{ secrets.KEY_PASSWORD }}
+          STORE_PASSWORD: ${{ secrets.STORE_PASSWORD }}
+        run: |
+          echo "$KEYSTORE_BASE64" | base64 --decode > release.jks
+          echo "storeFile=release.jks" > keystore.properties
+          echo "keyAlias=$KEY_ALIAS" >> keystore.properties
+          echo "keyPassword=$KEY_PASSWORD" >> keystore.properties
+          echo "storePassword=$STORE_PASSWORD" >> keystore.properties
 
       - name: Create release folder
         run: mkdir -p app/build/outputs/apk/release
 
-      - name: Build release APK
-        run: ./gradlew clean assembleRelease
+      - name: Build release artifacts
+        run: ./gradlew clean assembleRelease bundleGmsRelease
 
-      - name: Rename artifact
-        run: mv "app/build/outputs/apk/release/app-release.apk" "app/build/outputs/apk/release/SummaryExpressive-${{ env.VERSION_NAME }}(${{ env.VERSION_CODE }}).apk"
+      - name: Rename artifacts
+        run: |
+          mv "app/build/outputs/apk/gms/release/app-gms-release.apk" "app/build/outputs/apk/release/SummaryExpressive-gms-${{ env.VERSION_NAME }}(${{ env.VERSION_CODE }}).apk"
+          mv "app/build/outputs/apk/standalone/release/app-standalone-release.apk" "app/build/outputs/apk/release/SummaryExpressive-standalone-${{ env.VERSION_NAME }}(${{ env.VERSION_CODE }}).apk"
+#          TODO: pipeline to release to google play
+          mv "app/build/outputs/bundle/gmsRelease/app-gms-release.aab" "app/build/outputs/apk/release/SummaryExpressive-gms-${{ env.VERSION_NAME }}(${{ env.VERSION_CODE }}).aab"
 
       - name: Publish GitHub release
         uses: softprops/action-gh-release@v2
@@ -109,4 +125,4 @@ jobs:
           name: "Release ${{ env.VERSION_NAME }} (${{ env.VERSION_CODE }})"
           prerelease: false
           draft: false
-          files: app/build/outputs/apk/release/SummaryExpressive-${{ env.VERSION_NAME }}(${{ env.VERSION_CODE }}).apk
+          files: app/build/outputs/apk/release/SummaryExpressive-*.apk

README.md

@@ -24,7 +24,19 @@
 
 ---
 
-## Play Store Version (coming soon)
+## Download
+
+### Github Release
+
+There are 2 releases available:
+
+- **standalone** which
+  includes [ML model](https://developers.google.com/ml-kit/vision/text-recognition/v2) to recognize
+  text from image, it got larger package size.
+
+- **gms** which allows user to download the model from Google Play Services, but GMS required.
+
+### Play Store Version (coming soon)
 
 <a href='https://play.google.com/store/apps/details?id=me.nanova.SummaryExpressive'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width='300'/></a>
 
@@ -48,9 +60,3 @@
   dynamic color theme.
 
 It uses OpenAI/Gemini to summarize.
-
-<div align="right">
-<table><td>
-<a href="#start-of-content">👆 Scroll to top</a>
-</td></table>
-</div>

app/build.gradle.kts

@@ -1,3 +1,6 @@
+import java.util.Properties
+import java.io.FileInputStream
+
 plugins {
     id("com.android.application")
     id("org.jetbrains.kotlin.android")
@@ -9,19 +12,46 @@ plugins {
 android {
     namespace = "me.nanova.summaryexpressive"
     compileSdk = 36
+    flavorDimensions += "distribution"
     androidResources {
         generateLocaleConfig = true
     }
     defaultConfig {
         applicationId = "me.nanova.summaryexpressive"
         minSdk = 33
         targetSdk = 36
-        versionCode = 3
-        versionName = "0.0.3"
+        versionCode = 4
+        versionName = "0.0.4"
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
 
+    productFlavors {
+        create("gms") {
+            dimension = "distribution"
+        }
+        create("standalone") {
+            dimension = "distribution"
+            applicationIdSuffix = ".standalone"
+            versionNameSuffix = "-standalone"
+        }
     }
+
+    signingConfigs {
+        val keyPropertiesFile = rootProject.file("keystore.properties")
+        val keyProperties = Properties()
+        if (keyPropertiesFile.exists()) {
+            keyProperties.load(FileInputStream(keyPropertiesFile))
+        }
+
+        create("release") {
+            keyAlias = keyProperties.getProperty("keyAlias")
+            keyPassword = keyProperties.getProperty("keyPassword")
+            storeFile = if (keyProperties.getProperty("storeFile") != null) rootProject.file(keyProperties.getProperty("storeFile")) else null
+            storePassword = keyProperties.getProperty("storePassword")
+        }
+    }
+
     buildTypes {
         release {
             isMinifyEnabled = true
@@ -30,7 +60,7 @@ android {
                 getDefaultProguardFile("proguard-android-optimize.txt"),
                 "proguard-rules.pro"
             )
-            signingConfig = signingConfigs.getByName("debug")
+            signingConfig = signingConfigs.getByName("release")
         }
         getByName("debug") {
             signingConfig = signingConfigs.getByName("debug")
@@ -84,9 +114,9 @@ dependencies {
     implementation("androidx.datastore:datastore-preferences:1.1.7")
 
     // ml & llm
-    // this will bundle model to apk which is huge, use play service one first
-    //    implementation("com.google.mlkit:text-recognition:16.0.1")
-    implementation("com.google.android.gms:play-services-mlkit-text-recognition:19.0.1")
+    // this will bundle model to apk which is huge
+    "standaloneImplementation"("com.google.mlkit:text-recognition:16.0.1")
+    "gmsImplementation"("com.google.android.gms:play-services-mlkit-text-recognition:19.0.1")
     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.10.2")
     implementation("io.ktor:ktor-client-android:3.2.2")
     implementation("ai.koog:koog-agents:0.3.0") {