Merge branch 'release/0.1.2' into main

Author: bmarty

.gitattributes

@@ -1 +1,2 @@
 **/snapshots/**/*.png filter=lfs diff=lfs merge=lfs -text
+**/docs/images-lfs/*.png filter=lfs diff=lfs merge=lfs -text

.github/workflows/build.yml

@@ -2,9 +2,10 @@ name: APK Build
 
 on:
   workflow_dispatch:
-  pull_request: { }
+  pull_request:
+  merge_group:
   push:
-    branches: [ main, develop ]
+    branches: [ develop ]
 
 # Enrich gradle.properties for CI/CD
 env:
@@ -13,14 +14,17 @@ env:
 
 jobs:
   debug:
-    name: Build debug APKs
+    name: Build APKs
     runs-on: ubuntu-latest
-    if: github.ref != 'refs/heads/main'
+    # Skip for `main` and the merge queue if the branch is up to date with `develop`
+    if: github.ref != 'refs/heads/main' && github.event.merge_group.base_ref != 'refs/heads/develop'
     strategy:
+      matrix:
+        variant: [debug, release, nightly, samples]
       fail-fast: false
     # Allow all jobs on develop. Just one per PR.
     concurrency:
-      group: ${{ github.ref == 'refs/heads/develop' && format('build-develop-{0}', github.sha) || format('build-debug-{0}', github.ref)  }}
+      group: ${{ github.ref == 'refs/heads/develop' && format('build-develop-{0}-{1}', matrix.variant, github.sha) || format('build-{0}-{1}', matrix.variant, github.ref)  }}
       cancel-in-progress: true
     steps:
       - uses: actions/checkout@v3
@@ -34,14 +38,18 @@ jobs:
           distribution: 'temurin' # See 'Supported distributions' for available options
           java-version: '17'
       - name: Configure gradle
-        uses: gradle/gradle-build-action@v2.6.1
+        uses: gradle/gradle-build-action@v2.7.0
         with:
           cache-read-only: ${{ github.ref != 'refs/heads/develop' }}
       - name: Assemble debug APK
+        if: ${{ matrix.variant == 'debug' }}
         env:
           ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
-        run: ./gradlew assembleDebug $CI_GRADLE_ARG_PROPERTIES
-      - name: Upload debug APKs
+          ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
+          ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
+        run: ./gradlew assembleDebug -PallWarningsAsErrors=true $CI_GRADLE_ARG_PROPERTIES
+      - name: Upload APK APKs
+        if: ${{ matrix.variant == 'debug' }}
         uses: actions/upload-artifact@v3
         with:
           name: elementx-debug
@@ -53,12 +61,12 @@ jobs:
         continue-on-error: true
         env:
           token: ${{ secrets.DIAWI_TOKEN }}
-        if: ${{ github.event_name == 'pull_request' && env.token != '' }}
+        if: ${{ matrix.variant == 'debug' && github.event_name == 'pull_request' && env.token != '' }}
         with:
           token: ${{ env.token }}
           file: app/build/outputs/apk/debug/app-arm64-v8a-debug.apk
       - name: Add or update PR comment with QR Code to download APK.
-        if: ${{ github.event_name == 'pull_request' && steps.diawi.conclusion == 'success' }}
+        if: ${{ matrix.variant == 'debug' && github.event_name == 'pull_request' && steps.diawi.conclusion == 'success' }}
         uses: NejcZdovc/comment-pr@v2
         with:
           message: |
@@ -70,8 +78,11 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Compile release sources
-        run: ./gradlew compileReleaseSources $CI_GRADLE_ARG_PROPERTIES
+        if: ${{ matrix.variant == 'release' }}
+        run: ./gradlew compileReleaseSources -PallWarningsAsErrors=true $CI_GRADLE_ARG_PROPERTIES
       - name: Compile nightly sources
-        run: ./gradlew compileNightlySources $CI_GRADLE_ARG_PROPERTIES
+        if: ${{ matrix.variant == 'nightly' }}
+        run: ./gradlew compileNightlySources -PallWarningsAsErrors=true $CI_GRADLE_ARG_PROPERTIES
       - name: Compile samples minimal
+        if: ${{ matrix.variant == 'samples' }}
         run: ./gradlew :samples:minimal:assemble $CI_GRADLE_ARG_PROPERTIES

.github/workflows/danger.yml

@@ -1,17 +1,19 @@
 name: Danger CI
 
-on: [pull_request]
+on: [pull_request, merge_group]
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    # Don't run in the merge queue again if the branch is up to date with `develop`
+    if: github.event.merge_group.base_ref != 'refs/heads/develop'
     name: Danger main check
     steps:
       - uses: actions/checkout@v3
       - run: |
           npm install --save-dev @babel/plugin-transform-flow-strip-types
       - name: Danger
-        uses: danger/[email protected].6
+        uses: danger/[email protected].8
         with:
           args: "--dangerfile ./tools/danger/dangerfile.js"
         env:

.github/workflows/gradle-wrapper-validation.yml

@@ -1,12 +1,15 @@
 name: "Validate Gradle Wrapper"
 on:
-  pull_request: { }
+  pull_request:
+  merge_group:
   push:
     branches: [ main, develop ]
 
 jobs:
   validation:
     name: "Validation"
+    # Don't run in the merge queue again if the branch is up to date with `develop`
+    if: github.event.merge_group.base_ref != 'refs/heads/develop'
     runs-on: ubuntu-latest
     # No concurrency required, this is a prerequisite to other actions and should run every time.
     steps:

.github/workflows/maestro.yml

@@ -38,16 +38,14 @@ jobs:
         run: ./gradlew assembleDebug $CI_GRADLE_ARG_PROPERTIES
         env:
           ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
-      - name: Upload debug APKs
-        uses: actions/upload-artifact@v3
-        with:
-          name: elementx-debug
-          path: |
-            app/build/outputs/apk/debug/*.apk
+          ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
+          ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
       - uses: mobile-dev-inc/[email protected]
         with:
           api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
-          app-file: app/build/outputs/apk/debug/app-universal-debug.apk
+          # Doc says (https://github.com/mobile-dev-inc/action-maestro-cloud#android):
+          # app-file should point to an x86 compatible APK file, so upload the x86_64 one (much smaller than the universal APK).
+          app-file: app/build/outputs/apk/debug/app-x86_64-debug.apk
           env: |
             USERNAME=maestroelement
             PASSWORD=${{ secrets.MATRIX_MAESTRO_ACCOUNT_PASSWORD }}

.github/workflows/nightly.yml

@@ -1,4 +1,4 @@
-name: Build and release nightly APK
+name: Build and release nightly application
 
 on:
   workflow_dispatch:
@@ -12,7 +12,7 @@ env:
 
 jobs:
   nightly:
-    name: Build and publish nightly APK to Firebase
+    name: Build and publish nightly bundle to Firebase
     runs-on: ubuntu-latest
     if: ${{ github.repository == 'vector-im/element-x-android' }}
     steps:
@@ -31,18 +31,21 @@ jobs:
           sed 's/CHANGES\.md/CHANGES_NIGHTLY\.md/' towncrier.toml.bak > towncrier.toml
           rm towncrier.toml.bak
           yes n | towncrier build --version nightly
-      - name: Build and upload Nightly APK
+      - name: Build and upload Nightly application
         run: |
           ./gradlew assembleNightly appDistributionUploadNightly $CI_GRADLE_ARG_PROPERTIES
         env:
           ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
+          ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
+          ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
           ELEMENT_ANDROID_NIGHTLY_KEYID: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_KEYID }}
           ELEMENT_ANDROID_NIGHTLY_KEYPASSWORD: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_KEYPASSWORD }}
           ELEMENT_ANDROID_NIGHTLY_STOREPASSWORD: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_STOREPASSWORD }}
           FIREBASE_TOKEN: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_FIREBASE_TOKEN }}
       - name: Additionally upload Nightly APK to browserstack for testing
         continue-on-error: true # don't block anything by this upload failing (for now)
-        run: curl -u "$BROWSERSTACK_USERNAME:$BROWSERSTACK_PASSWORD" -X POST "https://api-cloud.browserstack.com/app-automate/upload" -F "file=@app/build/outputs/apk/nightly/app-universal-nightly.apk" -F "custom_id=element-x-android-nightly"
+        run: |
+          curl -u "$BROWSERSTACK_USERNAME:$BROWSERSTACK_PASSWORD" -X POST "https://api-cloud.browserstack.com/app-automate/upload" -F "file=@app/build/outputs/apk/nightly/app-universal-nightly.apk" -F "custom_id=element-x-android-nightly"
         env:
           BROWSERSTACK_USERNAME: ${{ secrets.ELEMENT_ANDROID_BROWSERSTACK_USERNAME }}
           BROWSERSTACK_PASSWORD: ${{ secrets.ELEMENT_ANDROID_BROWSERSTACK_ACCESS_KEY }}

.github/workflows/nightlyReports.yml

@@ -62,7 +62,7 @@ jobs:
           distribution: 'temurin' # See 'Supported distributions' for available options
           java-version: '17'
       - name: Configure gradle
-        uses: gradle/gradle-build-action@v2.6.1
+        uses: gradle/gradle-build-action@v2.7.0
         with:
           cache-read-only: ${{ github.ref != 'refs/heads/develop' }}
       - name: Dependency analysis

.github/workflows/quality.yml

@@ -2,7 +2,8 @@ name: Code Quality Checks
 
 on:
   workflow_dispatch:
-  pull_request: { }
+  pull_request:
+  merge_group:
   push:
     branches: [ main, develop ]
 
@@ -15,6 +16,8 @@ jobs:
   checkScript:
     name: Search for forbidden patterns
     runs-on: ubuntu-latest
+    # Don't run in the merge queue again if the branch is up to date with `develop`
+    if: github.event.merge_group.base_ref != 'refs/heads/develop'
     steps:
       - uses: actions/checkout@v3
       - name: Run code quality check suite
@@ -23,6 +26,8 @@ jobs:
   check:
     name: Project Check Suite
     runs-on: ubuntu-latest
+    # Don't run in the merge queue again if the branch is up to date with `develop`
+    if: github.event.merge_group.base_ref != 'refs/heads/develop'
     # Allow all jobs on main and develop. Just one per PR.
     concurrency:
       group: ${{ github.ref == 'refs/heads/main' && format('check-main-{0}', github.sha) || github.ref == 'refs/heads/develop' && format('check-develop-{0}', github.sha) || format('check-{0}', github.ref) }}
@@ -39,7 +44,7 @@ jobs:
           distribution: 'temurin' # See 'Supported distributions' for available options
           java-version: '17'
       - name: Configure gradle
-        uses: gradle/gradle-build-action@v2.6.1
+        uses: gradle/gradle-build-action@v2.7.0
         with:
           cache-read-only: ${{ github.ref != 'refs/heads/develop' }}
       - name: Run code quality check suite
@@ -65,7 +70,7 @@ jobs:
           yarn add danger-plugin-lint-report --dev
       - name: Danger lint
         if: always()
-        uses: danger/[email protected].6
+        uses: danger/[email protected].8
         with:
           args: "--dangerfile ./tools/danger/dangerfile-lint.js"
         env:

.github/workflows/recordScreenshots.yml

@@ -24,7 +24,7 @@ jobs:
           java-version: '17'
       # Add gradle cache, this should speed up the process
       - name: Configure gradle
-        uses: gradle/gradle-build-action@v2.6.1
+        uses: gradle/gradle-build-action@v2.7.0
         with:
           cache-read-only: ${{ github.ref != 'refs/heads/develop' }}
       - name: Record screenshots

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: Create release App Bundle
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ main ]
+
+# Enrich gradle.properties for CI/CD
+env:
+  GRADLE_OPTS: -Dorg.gradle.jvmargs="-Xmx3072m -Dfile.encoding=UTF-8 -XX:+HeapDumpOnOutOfMemoryError" -Dkotlin.daemon.jvm.options="-Xmx2560m" -Dkotlin.incremental=false
+  CI_GRADLE_ARG_PROPERTIES: --stacktrace -PpreDexEnable=false --max-workers 2 --no-daemon
+
+jobs:
+  release:
+    name: Create App Bundle
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.ref == 'refs/head/main' && format('build-release-main-{0}', github.sha) }}
+      cancel-in-progress: true
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin' # See 'Supported distributions' for available options
+          java-version: '17'
+      - name: Configure gradle
+        uses: gradle/[email protected]
+      - name: Create app bundle
+        env:
+          ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
+          ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
+          ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
+        run: ./gradlew bundleRelease $CI_GRADLE_ARG_PROPERTIES
+      - name: Upload bundle as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: elementx-app-bundle-unsigned
+          path: |
+            app/build/outputs/bundle/release/app-release.aab