Merge pull request #42 from ryanw-mobile/chore/41-release-pipeline-look-for-and-insert-release-note-to-github-action-automated-builds

(#41) fix renovate pipeline and attach release note in release pipeline

Author: ryanw-mobile

.github/workflows/renovate_check.yml

@@ -35,10 +35,6 @@ jobs:
 
       - name: Debug Android Test
         run: xvfb-run ./gradlew :app:pixel2Api34DebugAndroidTest -Pandroid.testoptions.manageddevices.emulator.gpu=swiftshader_indirect -Pandroid.experimental.testOptions.managedDevices.emulator.showKernelLogging=true -Pandroid.experimental.testOptions.managedDevices.maxConcurrentDevices=1 -Pandroid.experimental.testOptions.managedDevices.setupTimeoutMinutes=180
-        env:
-          CI: 'true'
 
       - name: Gradle Check
         run: ./gradlew check assembleDebug --no-daemon
-        env:
-          CI: 'true'

.github/workflows/tag_create_release.yml

@@ -7,6 +7,8 @@ jobs:
   build-and-release:
     if: github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/release/')
     runs-on: ubuntu-latest
+    env:
+      app_name: "cidemo"
     steps:
       - name: Decode Keystore
         id: decode_keystore
@@ -39,6 +41,21 @@ jobs:
       - name: Extract Version Number
         run: echo "version=${GITHUB_REF#refs/tags/release/}" >> $GITHUB_ENV
 
+      - name: Prepare Release Notes
+        id: release_notes
+        run: |
+          file_path="release_notes/release_note_${{ env.version }}.md"
+          if [ -f "$file_path" ]; then
+            echo "Using release notes from $file_path"
+            content=$(cat "$file_path")
+          else
+            echo "Using default release notes"
+            content="Description of the release for version ${{ env.version }}"
+          fi
+          echo "release_body<<EOF" >> $GITHUB_OUTPUT
+          echo "$content" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1
@@ -49,7 +66,7 @@ jobs:
           release_name: Release ${{ env.version }}
           draft: false
           prerelease: false
-          body: "Description of the release for version ${{ env.version }}"
+          body: ${{ steps.release_notes.outputs.release_body }}
           commitish: ${{ github.sha }}
 
       - name: Upload Release Asset Mapping
@@ -65,7 +82,7 @@ jobs:
 
       - name: Find APK file
         run: |
-          apk_path=$(find ./app/build/outputs/apk/release -name "cidemo-*.apk" | head -n 1)
+          apk_path=$(find ./app/build/outputs/apk/release -name "${{ env.app_name }}-*.apk" | head -n 1)
           echo "apk_path=$apk_path" >> $GITHUB_ENV
 
       - name: Upload Release Asset APK
@@ -80,7 +97,7 @@ jobs:
 
       - name: Find AAB file
         run: |
-          aab_path=$(find ./app/build/outputs/bundle/release -name "cidemo-*.aab" | head -n 1)
+          aab_path=$(find ./app/build/outputs/bundle/release -name "${{ env.app_name }}-*.aab" | head -n 1)
           echo "aab_path=$aab_path" >> $GITHUB_ENV
 
       - name: Upload Release Asset AAB

app/build.gradle.kts

@@ -175,55 +175,51 @@ private fun BaseAppModuleExtension.setupPackagingResourcesDeduplication() {
 }
 
 private fun BaseAppModuleExtension.setupSigningAndBuildTypes() {
-    signingConfigs {
-        create("releaseSigningConfig") {
-            // Only initialise the signing config when a Release or Bundle task is being executed.
-            // This prevents Gradle sync or debug builds from attempting to load the keystore,
-            // which could fail if the keystore or environment variables are not available.
-            // SigningConfig itself is only wired to the 'release' build type, so this guard avoids unnecessary setup.
-            val isReleaseBuild =
-                gradle.startParameter.taskNames.any {
-                    it.contains("Release", ignoreCase = true) ||
-                            it.contains("Bundle", ignoreCase = true) ||
-                            it.equals("build", ignoreCase = true)
-                }
+    val releaseSigningConfigName = "releaseSigningConfig"
+    val timestamp = SimpleDateFormat("yyyyMMdd-HHmmss").format(Date())
+    val baseName = "$productApkName-${libs.versions.versionName.get()}-$timestamp"
+    val isReleaseBuild = gradle.startParameter.taskNames.any {
+        it.contains("Release", ignoreCase = true)
+                || it.contains("Bundle", ignoreCase = true)
+                || it.equals("build", ignoreCase = true)
+    }
 
-            if (isReleaseBuild || isRunningOnCI) {
-                val keystorePropertiesFile = file("../../keystore.properties")
+    extensions.configure<BasePluginExtension> { archivesName.set(baseName) }
 
-                if (isRunningOnCI || !keystorePropertiesFile.exists()) {
-                    println("⚠\uFE0F Signing Config: using environment variables")
-                    keyAlias = System.getenv("CI_ANDROID_KEYSTORE_ALIAS")
-                    keyPassword = System.getenv("CI_ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD")
-                    storeFile = file(System.getenv("KEYSTORE_LOCATION"))
-                    storePassword = System.getenv("CI_ANDROID_KEYSTORE_PASSWORD")
-                } else {
-                    println("⚠\uFE0F Signing Config: using keystore properties")
-                    val properties = Properties()
-                    InputStreamReader(
-                        FileInputStream(keystorePropertiesFile),
-                        Charsets.UTF_8,
-                    ).use { reader ->
-                        properties.load(reader)
-                    }
+    signingConfigs.create(releaseSigningConfigName) {
+        // Only initialise the signing config when a Release or Bundle task is being executed.
+        // This prevents Gradle sync or debug builds from attempting to load the keystore,
+        // which could fail if the keystore or environment variables are not available.
+        // SigningConfig itself is only wired to the 'release' build type, so this guard avoids unnecessary setup.
+        if (isReleaseBuild) {
+            val keystorePropertiesFile = file("../../keystore.properties")
 
-                    keyAlias = properties.getProperty("alias")
-                    keyPassword = properties.getProperty("pass")
-                    storeFile = file(properties.getProperty("store"))
-                    storePassword = properties.getProperty("storePass")
-                }
+            if (isRunningOnCI || !keystorePropertiesFile.exists()) {
+                println("⚠\uFE0F Signing Config: using environment variables")
+                keyAlias = System.getenv("CI_ANDROID_KEYSTORE_ALIAS")
+                keyPassword = System.getenv("CI_ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD")
+                storeFile = file(System.getenv("KEYSTORE_LOCATION"))
+                storePassword = System.getenv("CI_ANDROID_KEYSTORE_PASSWORD")
             } else {
-                println("⚠\uFE0F Warning: Signing Config not created for non-release builds.")
+                println("⚠\uFE0F Signing Config: using keystore properties")
+                val properties = Properties()
+                InputStreamReader(
+                    FileInputStream(keystorePropertiesFile),
+                    Charsets.UTF_8,
+                ).use { reader ->
+                    properties.load(reader)
+                }
+
+                keyAlias = properties.getProperty("alias")
+                keyPassword = properties.getProperty("pass")
+                storeFile = file(properties.getProperty("store"))
+                storePassword = properties.getProperty("storePass")
             }
+        } else {
+            println("⚠\uFE0F Signing Config: not created for non-release builds.")
         }
     }
 
-    val timestamp = SimpleDateFormat("yyyyMMdd-HHmmss").format(Date())
-    val baseName = "$productApkName-${libs.versions.versionName.get()}-$timestamp"
-    extensions.configure<BasePluginExtension> {
-        archivesName.set(baseName)
-    }
-
     buildTypes {
         fun setOutputFileName() {
             applicationVariants.all {
@@ -253,7 +249,7 @@ private fun BaseAppModuleExtension.setupSigningAndBuildTypes() {
                     "proguard-rules.pro",
                 ),
             )
-            signingConfig = signingConfigs.getByName("releaseSigningConfig")
+            signingConfig = signingConfigs.getByName(name = releaseSigningConfigName)
             setOutputFileName()
         }
     }

release_notes/release_note_v1.1.0.md

@@ -0,0 +1,8 @@
+This release was generated by Github Actions.
+
+## What's Changed
+
+* Update Gradle to handle Renovate tests without keystore
+* Update CI pipeline to attach release note automatically
+
+**Full Changelog**: https://github.com/ryanw-mobile/testlab-release-ci/commits/release/v1.1.0