Added functionality to generate APK for a specified date. #4156

MohitMaliFtechiz · 2025-01-02T06:24:07Z

Fixes #4120

To generate the APK for a specific date, set the KIWIX_ANDROID_RELEASE_DATE environment variable in the format YYYY-MM-DD. The APK will be generated for the specified date. If the variable is not set, the APK will be generated for the current date.
Refactored all CD pipelines to generate APKs and app bundles based on the relevant git revision. The date is extracted from the specified git revision and set in the KIWIX_ANDROID_RELEASE_DATE environment variable, and the version code is generated for that date. See https://github.com/kiwix/kiwix-android/actions/runs/12608455860/job/35140926560.
Documented this new feature in the README.md file.
The testing_release job is skipped, if the application is being uploaded with the same version as the previously uploaded one, and Play Store gives the error for same version code. This prevents the CD pipeline from failing due to this error, while for all other errors, the workflow will fail as expected.

kelson42

Here my request for changes:

Rename the variable KIWIX_ANDROID_RELEASE_DATE
lastDate should be clearly identified as a constant in variable type and naming (should be LAST_DATE)
Document properly the feature in the README in a new section "Release".
Modify the CI and the CD so we use this feature

codecov · 2025-01-03T06:29:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.03%. Comparing base (359a1fc) to head (0ec90f0).

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #4156      +/-   ##
============================================
- Coverage     57.09%   57.03%   -0.06%     
+ Complexity     1525     1522       -3     
============================================
  Files           313      313              
  Lines         13399    13399              
  Branches       1662     1662              
============================================
- Hits           7650     7642       -8     
- Misses         4597     4601       +4     
- Partials       1152     1156       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

.github/workflows/dummy_bundle_and_apk.yml

+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: temurin
+
+      - name: Preparing signing material
+        env:
+          KEYSTORE: ${{ secrets.keystore }}
+        run: |
+          echo "$KEYSTORE" | base64 -d > kiwix-android.keystore
+
+      - name: Retrieve date from TAG
+        id: extract_date
+        run: |
+          # Check if the tag matches the pattern 'dummy_bundle_and_apk_vYYYY-MM-DD'.
+          # If the date is found in the tag, it will be extracted and set as the RELEASE_DATE.
+          # If no date is found or the tag does not match, an empty string will be set for RELEASE_DATE,
+          # and Android will generate the APK and app bundle for the current date.
+          if [[ "${GITHUB_REF}" =~ dummy_bundle_and_apk_v([0-9]{4}-[0-9]{2}-[0-9]{2}) ]]; then
+             RELEASE_DATE="${BASH_REMATCH[1]}"
+          else
+             RELEASE_DATE=""
+          fi
+          echo "KIWIX_ANDROID_RELEASE_DATE=$RELEASE_DATE" >> $GITHUB_ENV
+
+      - name: Generate dummy Bundle and APKs
+        env:
+          KEY_ALIAS: ${{ secrets.KEY_ALIAS }}
+          KEY_PASSWORD: ${{ secrets.KEY_PASSWORD }}
+          KEY_STORE_PASSWORD: ${{ secrets.KEY_STORE_PASSWORD }}
+          KIWIX_ANDROID_RELEASE_DATE: ${{ env.KIWIX_ANDROID_RELEASE_DATE }}
+        run: |
+          ./gradlew bundlePlayStore assembleRelease --scan
+
+
+      - name: Get Bundle and APKs name and path
+        id: get-bundle-and-apk-paths
+        run: |
+          BUNDLE_PATH="app/build/outputs/bundle/playStore/kiwix-playStore.aab"
+          BUNDLE_NAME="PlayStoreDummyBundle.aab"
+          echo "bundle_path=$BUNDLE_PATH" >> $GITHUB_ENV
+          echo "bundle_name=$BUNDLE_NAME" >> $GITHUB_ENV
+          APK_DIR="app/build/outputs/apk/release/"
+          echo "apk_dir=$APK_DIR" >> $GITHUB_ENV
+
+      - name: Upload Bundle as an artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.bundle_name }}
+          path: ${{ env.bundle_path }}
+
+      - name: Upload All Release APKs as artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: ReleaseApks
+          path: ${{ env.apk_dir }}*.apk


MohitMaliFtechiz · 2025-01-03T09:18:33Z

Here my request for changes:
Rename the variable KIWIX_ANDROID_RELEASE_DATE
lastDate should be clearly identified as a constant in variable type and naming (should be LAST_DATE)
Document properly the feature in the README in a new section "Release".
Modify the CI and the CD so we use this feature

@kelson42 I have made the changes as you requested. If anything we can improve in this, please let me know.

kelson42

Wy LAST_DATE is not a const?

MohitMaliFtechiz · 2025-01-03T12:04:59Z

Wy LAST_DATE is not a const?

@kelson42 we can only declare primitives and strings in const, but here the type was LocalDate that's why LAST_DATE was not const. But you have a valid point so I have changed the logic and made the LAST_DATE const d06985e.

kelson42 · 2025-01-03T13:15:47Z

Refactored testing_release CD workflow to generate and publish the application on the Play Store based on a specified date, using a new tag format internal_testing_v* where * is replaced by the date in YYYY-MM-DD, which is extracted and set as an environment variable to generate the app bundle for that date, defaulting to the current date if no date is provided, and uploading the generated app bundle to the Play Store.

We refactored our dummy_bundle.yml workflow to generate the dummy bundle and APKs based on a specified date, using a new tag format dummy_bundle_and_apk_v*, where * is replaced by the date in YYYY_MM_DD. This date is extracted and set as an environment variable to generate the app bundle and APK for that date, defaulting to the current date if no date is provided. See https://github.com/kiwix/kiwix-android/actions/runs/12594061109

Why do you need that? I expect you to just modify the workflows to extract the date from the concerned git revision? Something you have forgotten to do on the release.yml too... looks like.

* To generate the APK for a specific date, set the "RELEASE_DATE" environment variable in the format `YYYY-MM-DD`. The APK will be generated for the specified date. If the variable is not set, the APK will be generated for the current date.

* Made `LAST_DATE` and `BASE_VERSION_CODE` constants, as these values are crucial for our app and should not be changed. We have marked them as constants and added comments to ensure they remain unchanged.

…application on the Play Store based on a specified date, using a new tag format `internal_testing_v*` where `*` is replaced by the date, which is extracted and set as an environment variable to generate the app bundle for that date, defaulting to the current date if no date is provided, and uploading the generated app bundle to the Play Store.

…undle and APKs based on a specified date, using a new tag format `dummy_bundle_and_apk_v*`, where `*` is replaced by the date in `YYYY_MM_DD`. This date is extracted and set as an environment variable to generate the app bundle and APK for that date, defaulting to the current date if no date is provided. * Now, our `dummy_bundle.yml` will generate both the app bundle and APKs, so if we need the APK for a specified date, we can easily retrieve it. * Added comments in both workflows to understand the flow of the workflows.

…e can be easily used.

MohitMaliFtechiz · 2025-01-04T05:23:26Z

Why do you need that?

@kelson42 We need this to generate the APK or app bundle for the given date if we want to generate the APK or app bundle for a specific day. Like here we are not able to rebuild the APK for the same date while uploading it on the IzzyOnDroid. Since it can not generate the APK with the same version code if some other commits are added(on the next day).

I expect you to just modify the workflows to extract the date from the concerned git revision?

Okay, but it could lead to issues with our testing_release workflow. Here's why:

The testing_release workflow runs every Monday, even if no new commits are added. In such cases, it would try to build and upload the APK for the same date as the last published version. This would fail due to a duplicate version code.
However, the release workflow will work as intended since it only triggers when a new release is created.

Due to these reasons, I have made the changes like this. The current approach provides an additional feature, but I can remove it if you think it is not necessary. For the rest(extracting the date from git revision), we can add this with the current feature so that when these tags are not pushed it extracts the date from the concerned git revision generates the apk, and uploads it on the playStore(For testing_release, and dummy_bundle workflows). For the release workflow, I am making the changes.

Edited
I have thought more about this, and I believe uploading a new APK with the same codebase to the Play Store does not make sense since it lacks any new fixes. If the testing_release workflow fails due to the same version code issue, it should not be a significant problem. For generating the APK with the same version code, @IzzySoft handles it on their side by retrieving the date and providing it via an environment variable. For the dummy bundle and APK, our git revision feature will work fine since we cannot upload an APK to the Play Store with a previous version code. Therefore, we can proceed with the git revision feature.

… the relevant git revision. * The date is extracted from the specified git revision and set in the `KIWIX_ANDROID_RELEASE_DATE` environment variable, and the version code is generated for that date. * This feature has been added to the Release section in the README file.

kelson42 · 2025-01-04T07:10:47Z

Indeed, but worflow should not fail, it should detect if the upload error is because of same version and just say "upload skipped because very same version"... other upload reason should make the workflow fail.

Maybe even better is to check this... before uploading.

MohitMaliFtechiz · 2025-01-04T08:58:12Z

Maybe even better is to check this... before uploading.

@kelson42 I was also thinking about this, but there is no direct way to check the previously uploaded app's version code from the Play Store. To achieve this, we have to manually manage this like storing the previously uploaded app's version code somewhere and then receiving it on the CD.

Indeed, but worflow should not fail, it should detect if the upload error is because of same version and just say "upload skipped because very same version"... other upload reason should make the workflow fail.

We can do it.

…ded with the same version as the previously uploaded one, and Play Store gives the error for same version code. This prevents the CD pipeline from failing due to this error, while for all other errors, the workflow will fail as expected.

MohitMaliFtechiz · 2025-01-04T12:02:52Z

I have made the changes in the testing_release workflow.

kelson42

Few changes required.

kelson42 · 2025-01-04T12:59:47Z

.github/workflows/release.yml

+        id: git_date
+        run: |
+          DATE=$(git log -1 --format=%cd --date=format:%Y-%m-%d || echo "NoCommits")
+          if [ "$DATE" = "NoCommits" ]; then


Which scenario should here lead to "NoCommits" ?

This scenario can only occur when no commit is available in the concerned branch; I had added this just for the fallback mechanism. But it is unnecessary since this workflow always runs on the main branch and always has the commits.

kelson42 · 2025-01-04T13:00:25Z

.github/workflows/release.yml

+          else
+            RELEASE_DATE="$DATE"
+          fi
+          echo "KIWIX_ANDROID_RELEASE_DATE=$RELEASE_DATE" >> $GITHUB_ENV


please don't echo here in workflows.

@kelson42 It is for setting the env variable, not for printing its value see, without echo it will not store the output of "RELASE_DATE". However, this is a non-critical env variable so github printing it in the next job see.

kelson42 · 2025-01-04T13:01:16Z

buildSrc/src/main/kotlin/VersionCodeGenerator.kt

+  val currentDate = if (!System.getenv("KIWIX_ANDROID_RELEASE_DATE").isNullOrEmpty()) {
+    LocalDate.parse(System.getenv("KIWIX_ANDROID_RELEASE_DATE"))
+  } else {
+    LocalDate.now()


debug message should be here making clear the value of the date and where it comes from

I have added the log.

kelson42 · 2025-01-04T13:02:10Z

.github/workflows/release.yml

@@ -21,6 +21,18 @@ jobs:
      - name: Set tag variable
        run: echo "TAG=$(echo ${GITHUB_REF:10})" >> $GITHUB_ENV

+      - name: Retrieve date from git revision
+        id: git_date


variable name should better be git_head_revision_date

…gging purposes. * Improved the ID of the "Retrieve date from git revision" job. * Removed unnecessary conditions from the workflow.

MohitMaliFtechiz requested a review from kelson42 January 2, 2025 06:26

kelson42 requested changes Jan 2, 2025

View reviewed changes

MohitMaliFtechiz force-pushed the Fixes#4120 branch from ef1e846 to 887d543 Compare January 3, 2025 05:53

github-advanced-security bot found potential problems Jan 3, 2025

View reviewed changes

MohitMaliFtechiz requested a review from kelson42 January 3, 2025 09:18

kelson42 reviewed Jan 3, 2025

View reviewed changes

kelson42 force-pushed the Fixes#4120 branch from d06985e to 0897c89 Compare January 3, 2025 13:10

MohitMaliDeveloper added 6 commits January 4, 2025 10:01

Fixed: Reproducible Builds.

29616b1

* To generate the APK for a specific date, set the "RELEASE_DATE" environment variable in the format `YYYY-MM-DD`. The APK will be generated for the specified date. If the variable is not set, the APK will be generated for the current date.

Renamed the environment variable to KIWIX_ANDROID_RELEASE_DATE.

caa45c5

* Made `LAST_DATE` and `BASE_VERSION_CODE` constants, as these values are crucial for our app and should not be changed. We have marked them as constants and added comments to ensure they remain unchanged.

Documented this new feature in the README.md file so that this featur…

40285a7

…e can be easily used.

Made the LAST_DATE const so that it can not be changed.

ce83009

MohitMaliFtechiz marked this pull request as draft January 4, 2025 06:54

MohitMaliFtechiz force-pushed the Fixes#4120 branch from 0897c89 to 66f3d4d Compare January 4, 2025 07:00

MohitMaliFtechiz marked this pull request as ready for review January 4, 2025 07:04

MohitMaliFtechiz requested a review from kelson42 January 4, 2025 07:04

MohitMaliFtechiz marked this pull request as draft January 4, 2025 09:16

MohitMaliFtechiz marked this pull request as ready for review January 4, 2025 11:06

kelson42 requested changes Jan 4, 2025

View reviewed changes

Added logs to check whether the environment variable is set, for debu…

0ec90f0

…gging purposes. * Improved the ID of the "Retrieve date from git revision" job. * Removed unnecessary conditions from the workflow.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added functionality to generate APK for a specified date. #4156

Added functionality to generate APK for a specified date. #4156

MohitMaliFtechiz commented Jan 2, 2025 •

edited

Loading

kelson42 left a comment •

edited

Loading

codecov bot commented Jan 3, 2025 •

edited

Loading

MohitMaliFtechiz commented Jan 3, 2025

kelson42 left a comment

MohitMaliFtechiz commented Jan 3, 2025

kelson42 commented Jan 3, 2025 •

edited

Loading

MohitMaliFtechiz commented Jan 4, 2025 •

edited

Loading

kelson42 commented Jan 4, 2025 •

edited

Loading

MohitMaliFtechiz commented Jan 4, 2025

MohitMaliFtechiz commented Jan 4, 2025

kelson42 left a comment

kelson42 Jan 4, 2025

MohitMaliFtechiz Jan 6, 2025

kelson42 Jan 4, 2025

MohitMaliFtechiz Jan 6, 2025

kelson42 Jan 4, 2025

MohitMaliFtechiz Jan 6, 2025

kelson42 Jan 4, 2025

Added functionality to generate APK for a specified date. #4156

Are you sure you want to change the base?

Added functionality to generate APK for a specified date. #4156

Conversation

MohitMaliFtechiz commented Jan 2, 2025 • edited Loading

kelson42 left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jan 3, 2025 • edited Loading

Codecov Report

MohitMaliFtechiz commented Jan 3, 2025

kelson42 left a comment

Choose a reason for hiding this comment

MohitMaliFtechiz commented Jan 3, 2025

kelson42 commented Jan 3, 2025 • edited Loading

MohitMaliFtechiz commented Jan 4, 2025 • edited Loading

kelson42 commented Jan 4, 2025 • edited Loading

MohitMaliFtechiz commented Jan 4, 2025

MohitMaliFtechiz commented Jan 4, 2025

kelson42 left a comment

Choose a reason for hiding this comment

kelson42 Jan 4, 2025

Choose a reason for hiding this comment

MohitMaliFtechiz Jan 6, 2025

Choose a reason for hiding this comment

kelson42 Jan 4, 2025

Choose a reason for hiding this comment

MohitMaliFtechiz Jan 6, 2025

Choose a reason for hiding this comment

kelson42 Jan 4, 2025

Choose a reason for hiding this comment

MohitMaliFtechiz Jan 6, 2025

Choose a reason for hiding this comment

kelson42 Jan 4, 2025

Choose a reason for hiding this comment

MohitMaliFtechiz commented Jan 2, 2025 •

edited

Loading

kelson42 left a comment •

edited

Loading

codecov bot commented Jan 3, 2025 •

edited

Loading

kelson42 commented Jan 3, 2025 •

edited

Loading

MohitMaliFtechiz commented Jan 4, 2025 •

edited

Loading

kelson42 commented Jan 4, 2025 •

edited

Loading