Add detailed instructions about build types

Author: kiwibrowser

.github/workflows/build_apk.yml

@@ -391,16 +391,49 @@ jobs:
           prerelease: true
           body: |
             This release was automatically generated from GitHub ${{ github.ref }} in run ID ${{ github.run_id }}.
-            arm64 is compatible with most devices and offers the best performance.
-            It is recommended to use "-signed.apk" releases to get the latest versions.
+            
+            Summary:
+              - To install / update Kiwi Browser, use "Kiwi-${{ github.run_id }}-arm64-signed.apk".
+              If it doesn't work, try again using "Kiwi-${{ github.run_id }}-arm64-playstore.apk" (if it exists).
+
+            Detailed information about the different files:
+              - ".mapping" files are files that developers can use to investigate crashes, these files are not needed to run the browser and are for developers only.
+              - ".apk" files are packages that you have to install to use Kiwi Browser.
+
+            The filenames are in the form "Kiwi-[BUILD_VERSION]-[ARCHITECTURE]-[SIGNATURE_TYPE].apk"
+
+            Build version:
+              - Everytime a change is introduced in Kiwi Browser, a new build version is generated.
+
+            Architecture:
+              - "-arm64" is compatible with modern devices and offers the best performance.
+              - "-arm" is compatible with almost all devices and uses less memory.
+              - "-x86" and "-x64" builds are compatible with emulators and Intel compatible tablets.
+                
+            Signature type:
+              - On Android, applications have to be signed by a developer before they can be installed.
 
-            "-unsigned.apk" builds are signed using a random development key (upgrades / updates are not possible).
+            Kiwi has two types of builds:
 
-            "-signed.apk" builds are signed with the developer key (same as XDA-Developers, Discord and GitHub) and can be updated without data loss.
-            All builds are signed.
+            Signed by the developer:
+              - "-signed.apk" are builds signed using the official developer key.
+            A signed build is a build that comes straight from the GitHub official repository and is always the most updated.
+
+            Play Certified by Google:
+              - Once in a while, we send a "-signed.apk" build to be reviewed and signed by Google.
+            Google reviews the application, checks that the application is not malicious, adds the "Google Play Certified" badge, signs the file and this becomes "-playstore.apk".
+            
+            We then distribute "-playstore.apk" on Google Play, XDA-Developers, Samsung and other app stores.
+            
+            This process takes some time and is partially manual so not all GitHub builds have a "-playstore.apk".
             
-            "-playstore.apk" builds are signed by Google, they can be installed on top of Play Store releases only.
-            Not all builds are signed by Google.
+            On Android, you can install an update to an application only if it was signed by the same developer as the version that you currently have installed:
+              - You can install a "-signed.apk" build on top of a "-signed.apk" build, and a "-playstore.apk" build on top of a "-playstore.apk" build.
+              - You cannot install a "-playstore.apk" build on top of a "-signed.apk" build.
+                
+            Essentially, if you have a Google Play certified installation, you need to keep using the "-playstore.apk" files or the official updates.
+            
+            There is generally only a few days only before the build appears on the Play Store anyway.
 
       - name: Downloading artifact (arm)
         uses: actions/download-artifact@v1
@@ -422,7 +455,7 @@ jobs:
         with:
           name: apk-x64
 
-      - name: Uploading release asset (arm)
+      - name: Uploading APK into GitHub release (arm)
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -432,7 +465,7 @@ jobs:
           asset_name: Kiwi-${{ github.run_id }}-arm-unsigned.apk
           asset_content_type: application/vnd.android.package-archive
 
-      - name: Uploading release asset (arm64)
+      - name: Uploading APK into GitHub release (arm64)
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -442,7 +475,7 @@ jobs:
           asset_name: Kiwi-${{ github.run_id }}-arm64-unsigned.apk
           asset_content_type: application/vnd.android.package-archive
 
-      - name: Uploading release asset (x86)
+      - name: Uploading APK into GitHub release (x86)
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -452,7 +485,7 @@ jobs:
           asset_name: Kiwi-${{ github.run_id }}-x86-unsigned.apk
           asset_content_type: application/vnd.android.package-archive
 
-      - name: Uploading release asset (x64)
+      - name: Uploading APK into GitHub release (x64)
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -462,6 +495,46 @@ jobs:
           asset_name: Kiwi-${{ github.run_id }}-x64-unsigned.apk
           asset_content_type: application/vnd.android.package-archive
 
+      - name: Uploading mapping file into GitHub release (arm)
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./apk-arm/ChromePublic.apk.mapping
+          asset_name: Kiwi-${{ github.run_id }}-arm.mapping
+          asset_content_type: application/vnd.android.package-archive
+
+      - name: Uploading mapping file into GitHub release (arm64)
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./apk-arm64/ChromePublic.apk.mapping
+          asset_name: Kiwi-${{ github.run_id }}-arm64.mapping
+          asset_content_type: application/vnd.android.package-archive
+
+      - name: Uploading mapping file into GitHub release (x86)
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./apk-x86/ChromePublic.apk.mapping
+          asset_name: Kiwi-${{ github.run_id }}-x86.mapping
+          asset_content_type: application/vnd.android.package-archive
+
+      - name: Uploading mapping file into GitHub release (x64)
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./apk-x64/ChromePublic.apk.mapping
+          asset_name: Kiwi-${{ github.run_id }}-x64.mapping
+          asset_content_type: application/vnd.android.package-archive
+
       - name: Uploading artifacts to storage (Wasabi S3)
         if: ${{ github.repository_owner == 'kiwibrowser' }}
         env:
@@ -472,6 +545,10 @@ jobs:
           rclone copy --fast-list --transfers=16 ./apk-arm64/ChromePublic.apk sync:kiwibrowser-builds/${{ github.run_id }}/arm64/
           rclone copy --fast-list --transfers=16 ./apk-x86/ChromePublic.apk sync:kiwibrowser-builds/${{ github.run_id }}/x86/
           rclone copy --fast-list --transfers=16 ./apk-x64/ChromePublic.apk sync:kiwibrowser-builds/${{ github.run_id }}/x64/
+          rclone copy --fast-list --transfers=16 ./apk-arm/ChromePublic.apk.mapping sync:kiwibrowser-builds/${{ github.run_id }}/arm/
+          rclone copy --fast-list --transfers=16 ./apk-arm64/ChromePublic.apk.mapping sync:kiwibrowser-builds/${{ github.run_id }}/arm64/
+          rclone copy --fast-list --transfers=16 ./apk-x86/ChromePublic.apk.mapping sync:kiwibrowser-builds/${{ github.run_id }}/x86/
+          rclone copy --fast-list --transfers=16 ./apk-x64/ChromePublic.apk.mapping sync:kiwibrowser-builds/${{ github.run_id }}/x64/
 
       - name: Signing and uploading release to GitHub
         if: ${{ github.repository_owner == 'kiwibrowser' }}