auto build release apk through gh actions

Author: ichenhe

.github/workflows/release.yml

@@ -9,10 +9,14 @@ on:
 env:
   VERSION_BRANCH: version
   VERSION_FILE: version.properties
+  ARTIFACT_APK: release.apk
+  ARTIFACT_MAPPINGS: mappings
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    env:
+      QNEVO_SIGNING_STORE_PATH: ${{ github.workspace }}/release.jks
 
     steps:
       - uses: actions/checkout@v4
@@ -27,6 +31,33 @@ jobs:
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
 
+      - name: Write KeyStore File
+        uses: RollyPeres/base64-to-path@v1
+        with:
+          filePath: ${{ env.QNEVO_SIGNING_STORE_PATH }}
+          encodedString: ${{ secrets.SIGNING_KEYSTORE }}
+
+      - name: Assemble Release APK
+        run: ./gradlew assembleRelease
+        env:
+          QNEVO_SIGNING_STORE_PWD: ${{ secrets.SIGNING_STORE_PASSWORD }}
+          QNEVO_SIGNING_KEY_ALIAS: ${{ secrets.SIGNING_KEY_ALIAS }}
+          QNEVO_SIGNING_KEY_PWD: ${{ secrets.SIGNING_KEY_PASSWORD }}
+
+      - name: Upload APK
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.ARTIFACT_APK }}
+          path: "app/build/outputs/apk/release/app-release.apk"
+          if-no-files-found: error
+
+      - name: Upload Mapping Files
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.ARTIFACT_MAPPINGS }}
+          path: "app/build/outputs/mapping/release"
+          if-no-files-found: error
+
       - name: Generate Version Info
         run: ./gradlew appVersion
 
@@ -38,6 +69,37 @@ jobs:
           if-no-files-found: error
           retention-days: 1
 
+  draft-release:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      contents: write
+
+    steps:
+      - name: Download APK
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ env.ARTIFACT_APK }}
+
+      - name: Download Mappings
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ env.ARTIFACT_MAPPINGS }}
+          path: mappings
+
+      - name: Tar Mapping Files
+        run: |
+          cd mappings
+          tar -zcf mappings.tar.gz ./*
+          mv mappings.tar.gz ../
+          cd ..
+
+      - name: Release
+        uses: ncipollo/release-action@v1
+        with:
+          draft: true
+          artifactErrorsFailBuild: true
+          artifacts: "app-release.apk,mappings.tar.gz"
 
   # commit the version file to 'version' branch so that F-Droid can utilize it for new version detecting
   update-version:

app/build.gradle.kts

@@ -1,5 +1,4 @@
 import org.jetbrains.kotlin.config.JvmTarget
-import java.io.ByteArrayOutputStream
 import java.util.Properties
 
 plugins {
@@ -32,11 +31,25 @@ android {
         // must correspond to kotlin version: https://developer.android.com/jetpack/androidx/releases/compose-kotlin#pre-release_kotlin_compatibility
         kotlinCompilerExtensionVersion = "1.5.3"
     }
+    signingConfigs {
+        readSigningConfig()?.also { config ->
+            logger.lifecycle("Use key alias '{}' to sign release", config.keyAlias)
+            create("release") {
+                storeFile = config.storeFile
+                storePassword = "chenhe"
+                keyAlias = "weargallery"
+                keyPassword = "chenhe"
+
+                enableV2Signing = true
+            }
+        }
+    }
     buildTypes {
         release {
             isMinifyEnabled = true
             isShrinkResources = true
             proguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")
+            signingConfigs.findByName("release")?.also { signingConfig = it }
         }
     }
     compileOptions {
@@ -80,43 +93,24 @@ dependencies {
     testImplementation("org.json:json:20231013") // JSONObject
 }
 
-fun String.runCommand(currentWorkingDir: File = file("./")): String {
-    val byteOut = ByteArrayOutputStream()
-    project.exec {
-        workingDir = currentWorkingDir
-        commandLine = this@runCommand.split(" ")
-        standardOutput = byteOut
-    }
-    return String(byteOut.toByteArray()).trim()
-}
-
-fun getVersionCode(): Int {
-    val cmd = "git rev-list HEAD --first-parent --count"
-    return try {
-        cmd.runCommand().toInt()
-    } catch (e: Exception) {
-        logger.error("Failed to get version code with git, return 1 by default.\n${e.message}")
-        1
-    }
-}
+data class SigningConfig(
+    val storeFile: File,
+    val storePwd: String,
+    val keyAlias: String,
+    val keyPwd: String,
+)
 
-
-fun getVersionName(): String {
-    val cmd = "git describe --tags --long --first-parent --abbrev=7 --dirty=_dev"
-    try {
-        val v = cmd.runCommand()
-        val pattern = """^v(?<v>[\d|.]+)-\d+-g[A-Za-z0-9]{7}(?<s>_dev)?$""".toRegex()
-        val g = pattern.matchEntire(v)?.groups
-        if (g == null || g["v"] == null) {
-            logger.error(
-                "Failed to get version name with git.\n" +
-                        "Cannot match git tag describe, return <UNKNOWN> by default. raw=$v"
-            )
-            return "UNKNOWN"
-        }
-        return g["v"]!!.value + (g["s"]?.value ?: "")
-    } catch (e: Exception) {
-        logger.error("Failed to get version name with git, return <UNKNOWN> by default.\n${e.message}")
-        return "UNKNOWN"
+fun readSigningConfig(): SigningConfig? {
+    val path = System.getenv("QNEVO_SIGNING_STORE_PATH") ?: return null
+    val f = File(path)
+    if (!f.isFile) {
+        logger.warn("Key store file not exist: {}", path)
+        return null
     }
+    return SigningConfig(
+        storeFile = f,
+        storePwd = System.getenv("QNEVO_SIGNING_STORE_PWD") ?: return null,
+        keyAlias = System.getenv("QNEVO_SIGNING_KEY_ALIAS") ?: return null,
+        keyPwd = System.getenv("QNEVO_SIGNING_KEY_PWD") ?: return null
+    )
 }