Merge remote-tracking branch 'refs/remotes/origin/main' into request-…

…contributions

# Conflicts:
#	README.MD

.github/pull_request_template.md

@@ -1,3 +1,3 @@
 ## Why is this important?
 
-## Any review notes?
+## Notes

.github/workflows/_prepare-all.yml

@@ -0,0 +1,19 @@
+name: Prepare All
+
+on:
+  workflow_call:
+
+jobs:
+  prepare-all:
+    runs-on: macos-latest # use [ self-hosted, macOS ] to host on our own mac mini, which is twice as fast and cheaper than hosting on a github runner. See README for more info.
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: "corretto"
+          java-version: "21" # keep the same as your Android Studio version
+
+      - name: Setup Android SDK
+        uses: android-actions/setup-android@v3

.github/workflows/_prepare-release.yml

@@ -0,0 +1,16 @@
+name: Prepare Release
+
+on:
+  workflow_call:
+
+jobs:
+  prepareRelease:
+    runs-on: macos-latest # use [ self-hosted, macOS ] to host on our own mac mini, which is twice as fast and cheaper than hosting on a github runner. See README for more info.
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Update Version Code # we increase the version code with each build
+        uses: chkfung/[email protected]
+        with:
+          gradlePath: app/build.gradle
+          versionCode: ${{ github.run_number }}

.github/workflows/debug.yml

@@ -0,0 +1,34 @@
+name: Debug Builds
+
+on: [ push ] # run on all pushes on any branch
+
+jobs:
+  prepare-all:
+    uses: ./.github/workflows/_prepare-all.yml
+  build:
+    runs-on: macos-latest # use [ self-hosted, macOS ] to host on our own mac mini, which is twice as fast and cheaper than hosting on a github runner. See README for more info.
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build Debug APK
+        run: ./gradlew assembleDevDebug --stacktrace
+
+      - name: Run unit tests
+        run: ./gradlew test --stacktrace
+
+      - name: Upload Dev Debug APK to Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ github.event.repository.name }}-${{ github.run_number }}-dev-debug-apk
+          path: |
+            ${{ github.workspace }}/app/build/outputs/apk/dev/debug/app-dev-debug.apk
+
+      - name: Build Prod APK
+        run: ./gradlew assembleProdDebug --stacktrace
+
+      - name: Upload Prod Debug APK to Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ github.event.repository.name }}_${{ github.run_number }}-prod-debug-apk
+          path: |
+            ${{ github.workspace }}/app/build/outputs/apk/prod/debug/app-prod-debug.apk

.github/workflows/publish.yml

@@ -0,0 +1,61 @@
+name: Release Builds
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches: [ 'develop' ]
+
+jobs:
+  prepare-all:
+    uses: ./.github/workflows/_prepare-all.yml
+  prepare-release:
+    uses: ./.github/workflows/_prepare-release.yml
+  build:
+    runs-on: macos-latest # use [ self-hosted, macOS ] to host on our own mac mini, which is twice as fast and cheaper than hosting on a github runner. See README for more info.
+    steps:
+      - uses: actions/checkout@v4
+
+      # This will decode the keystore from base 64 text representation that we have stored in secrets
+      # and generates and keystore file and gets stored in /android-app path
+      - name: Decode Keystore
+        env:
+          ENCODED_STRING: ${{ secrets.KEYSTORE_BASE_64 }}
+        shell: bash
+        run: |
+          echo $ENCODED_STRING > keystore-b64.txt
+          base64 -d <keystore-b64.txt >upload-keystore.jks
+
+      - name: Build Prod Release APK
+        env:
+          RELEASE_KEYSTORE_PASSWORD: ${{ secrets.RELEASE_KEYSTORE_PASSWORD }}
+          RELEASE_KEYSTORE_ALIAS: ${{ secrets.RELEASE_KEYSTORE_ALIAS }}
+          RELEASE_KEY_PASSWORD: ${{ secrets.RELEASE_KEY_PASSWORD }}
+        run: ./gradlew assembleProdRelease --stacktrace
+
+      - name: Upload Release APK to Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ github.event.repository.name }}-${{ github.run_number }}-prod-release-apk
+          path: |
+            ${{ github.workspace }}/app/build/outputs/apk/prod/release/app-prod-release.apk
+
+      - name: Upload Prod Release APK to Firebase App Distribution
+        uses: nickwph/firebase-app-distribution-action@v1
+        with:
+          file: ${{ github.workspace }}/app/build/outputs/apk/prod/release/app-prod-release.apk
+          app: ${{ secrets.FIREBASE_PROD_APP_ID }}
+          credentials: ${{ secrets.FIREBASE_CREDENTIALS }}
+
+      - name: Build Prod Release Bundle
+        env:
+          RELEASE_KEYSTORE_PASSWORD: ${{ secrets.RELEASE_KEYSTORE_PASSWORD }}
+          RELEASE_KEYSTORE_ALIAS: ${{ secrets.RELEASE_KEYSTORE_ALIAS }}
+          RELEASE_KEY_PASSWORD: ${{ secrets.RELEASE_KEY_PASSWORD }}
+        run: ./gradlew bundleProdRelease --stacktrace
+
+      - name: Upload Release Bundle to Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ github.event.repository.name }}-${{ github.run_number }}-prod-release-bundle
+          path: |
+            ${{ github.workspace }}/app/build/outputs/bundle/prodRelease/app-prod-release.aab

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: Release Builds
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches: [ '*' ] # run on all pull requests
+
+jobs:
+  prepare-all:
+    uses: ./.github/workflows/_prepare-all.yml
+  prepare-release:
+    uses: ./.github/workflows/_prepare-release.yml
+  build:
+    runs-on: macos-latest # use [ self-hosted, macOS ] to host on our own mac mini, which is twice as fast and cheaper than hosting on a github runner. See README for more info.
+    steps:
+      - uses: actions/checkout@v4
+
+      # This will decode the keystore from base 64 text representation that we have stored in secrets
+      # and generates and keystore file and gets stored in /android-app path
+      - name: Decode Keystore
+        env:
+          ENCODED_STRING: ${{ secrets.KEYSTORE_BASE_64 }}
+        shell: bash
+        run: |
+          echo $ENCODED_STRING > keystore-b64.txt
+          base64 -d <keystore-b64.txt >upload-keystore.jks
+
+      - name: Build Prod Release APK
+        env:
+          RELEASE_KEYSTORE_PASSWORD: ${{ secrets.RELEASE_KEYSTORE_PASSWORD }}
+          RELEASE_KEYSTORE_ALIAS: ${{ secrets.RELEASE_KEYSTORE_ALIAS }}
+          RELEASE_KEY_PASSWORD: ${{ secrets.RELEASE_KEY_PASSWORD }}
+        run: ./gradlew assembleProdRelease --stacktrace
+
+      - name: Upload Release APK to Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ github.event.repository.name }}-${{ github.run_number }}-prod-release-apk
+          path: |
+            ${{ github.workspace }}/app/build/outputs/apk/prod/release/app-prod-release.apk