Merge branch 'release/0.4.16' into main

Author: ganfra

.github/pull_request_template.md

@@ -55,7 +55,7 @@ Uncomment this markdown table below and edit the last line `|||`:
 - [ ] UI change has been tested on both light and dark themes
 - [ ] Accessibility has been taken into account. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#accessibility
 - [ ] Pull request is based on the develop branch
-- [ ] Pull request includes a new file under ./changelog.d. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#changelog
+- [ ] Pull request title will be used in the release note, it clearly define what will change for the user
 - [ ] Pull request includes screenshots or videos if containing UI changes
 - [ ] Pull request includes a [sign off](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#sign-off)
 - [ ] You've made a self review of your PR

.github/release.yml

@@ -0,0 +1,34 @@
+changelog:
+  categories:
+    - title: ✨ Features
+      labels:
+        - PR-Feature
+    - title: 🙌 Improvements
+      labels:
+        - PR-Change
+    - title: 🐛 Bugfixes
+      labels:
+        - PR-Bugfix
+    - title: ⚠️ API Changes
+      labels:
+        - PR-Api
+    - title: 🗣 Translations
+      labels:
+        - PR-i18n
+    - title: 🧱 Build
+      labels:
+        - PR-Build
+    - title: 📄 Documentation
+      labels:
+        - PR-Doc
+    - title: 🚧 In development 🚧
+      labels:
+        - PR-Wip
+    - title: Dependency upgrades
+      labels:
+        - PR-Dependencies
+
+    - title: Others
+      labels:
+        - PR-misc
+        - "*"

.github/renovate.json

@@ -4,7 +4,7 @@
     "config:base"
   ],
   "labels" : [
-    "dependencies"
+    "PR-Dependencies"
   ],
   "ignoreDeps" : [
     "string:app_name"

.github/workflows/build.yml

@@ -16,8 +16,6 @@ jobs:
   debug:
     name: Build APKs
     runs-on: ubuntu-latest
-    # Skip for `main`
-    if: github.ref != 'refs/heads/main'
     strategy:
       matrix:
         variant: [debug, release, nightly, samples]

.github/workflows/build_enterprise.yml

@@ -0,0 +1,69 @@
+name: Enterprise APK Build
+
+on:
+  workflow_dispatch:
+  pull_request:
+  merge_group:
+  push:
+    branches: [ develop ]
+
+# Enrich gradle.properties for CI/CD
+env:
+  GRADLE_OPTS: -Dorg.gradle.jvmargs="-Xmx7g -XX:MaxMetaspaceSize=512m -Dfile.encoding=UTF-8 -XX:+HeapDumpOnOutOfMemoryError" -Dkotlin.incremental=false -XX:+UseG1GC
+  CI_GRADLE_ARG_PROPERTIES: --stacktrace -Dsonar.gradle.skipCompile=true
+
+jobs:
+  build:
+    name: Build Enterprise APKs
+    runs-on: ubuntu-latest
+    # Skip in forks
+    if: github.repository == 'element-hq/element-x-android'
+    strategy:
+      matrix:
+        variant: [debug, release, nightly]
+      fail-fast: false
+    # Allow all jobs on develop. Just one per PR.
+    concurrency:
+      group: ${{ github.ref == 'refs/heads/develop' && format('build-develop-enterprise-{0}-{1}', matrix.variant, github.sha) || format('build-enterprise-{0}-{1}', matrix.variant, github.ref)  }}
+      cancel-in-progress: true
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Ensure we are building the branch and not the branch after being merged on develop
+          # https://github.com/actions/checkout/issues/881
+          ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }}
+      - name: Add SSH private keys for submodule repositories
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
+      - name: Clone submodules
+        run: git submodule update --init --recursive
+      - name: Use JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin' # See 'Supported distributions' for available options
+          java-version: '17'
+      - name: Configure gradle
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          cache-read-only: ${{ github.ref != 'refs/heads/develop' }}
+      - name: Assemble debug Gplay Enterprise APK
+        if: ${{ matrix.variant == 'debug' }}
+        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 :app:assembleGplayDebug -PallWarningsAsErrors=true $CI_GRADLE_ARG_PROPERTIES
+      - name: Upload debug Enterprise APKs
+        if: ${{ matrix.variant == 'debug' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: elementx-enterprise-debug
+          path: |
+            app/build/outputs/apk/gplay/debug/*-universal-debug.apk
+      - name: Compile release sources
+        if: ${{ matrix.variant == 'release' }}
+        run: ./gradlew compileReleaseSources -PallWarningsAsErrors=true $CI_GRADLE_ARG_PROPERTIES
+      - name: Compile nightly sources
+        if: ${{ matrix.variant == 'nightly' }}
+        run: ./gradlew compileGplayNightlySources -PallWarningsAsErrors=true $CI_GRADLE_ARG_PROPERTIES

.github/workflows/danger.yml

@@ -8,10 +8,17 @@ jobs:
     name: Danger main check
     steps:
       - uses: actions/checkout@v4
+      - name: Add SSH private keys for submodule repositories
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
+      - name: Clone submodules
+        if: github.repository == 'element-hq/element-x-android'
+        run: git submodule update --init --recursive
       - run: |
           npm install --save-dev @babel/plugin-transform-flow-strip-types
       - name: Danger
-        uses: danger/[email protected].2
+        uses: danger/[email protected].3
         with:
           args: "--dangerfile ./tools/danger/dangerfile.js"
         env:

.github/workflows/fork-pr-notice.yml

@@ -25,7 +25,7 @@ jobs:
               body: `Thank you for your contribution! Here are a few things to check in the PR to ensure it's reviewed as quickly as possible:
             
               - Your branch should be based on \`origin/develop\`, at least when it was created.
-              - There is a changelog entry in the \`changelog.d\` folder with [the Towncrier format](https://towncrier.readthedocs.io/en/latest/tutorial.html#creating-news-fragments).
+              - The title of the PR will be used for release notes, so it needs to describe the change visible to the user.
               - The test pass locally running \`./gradlew test\`.
               - The code quality check suite pass locally running \`./gradlew runQualityChecks\`.
               - If you modified anything related to the UI, including previews, you'll have to run the \`Record screenshots\` GH action in your forked repo: that will generate compatible new screenshots. However, given Github Actions limitations, **it will prevent the CI from running temporarily**, until you upload a new commit after that one. To do so, just pull the latest changes and push [an empty commit](https://coderwall.com/p/vkdekq/git-commit-allow-empty).`

.github/workflows/nightly.yml

@@ -22,15 +22,6 @@ jobs:
         with:
           distribution: 'temurin' # See 'Supported distributions' for available options
           java-version: '17'
-      - name: Install towncrier
-        run: |
-          python3 -m pip install towncrier
-      - name: Prepare changelog file
-        run: |
-          mv towncrier.toml towncrier.toml.bak
-          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 application
         run: |
           ./gradlew assembleGplayNightly appDistributionUploadGplayNightly $CI_GRADLE_ARG_PROPERTIES

.github/workflows/nightly_enterprise.yml

@@ -0,0 +1,48 @@
+name: Build and release Enterprise nightly application
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Every nights at 4
+    - cron: "0 4 * * *"
+
+env:
+  GRADLE_OPTS: -Dorg.gradle.jvmargs="-Xmx6g -XX:MaxMetaspaceSize=512m -Dfile.encoding=UTF-8 -XX:+HeapDumpOnOutOfMemoryError" -Dkotlin.incremental=false -XX:+UseG1GC
+  CI_GRADLE_ARG_PROPERTIES: --stacktrace --no-daemon -Dsonar.gradle.skipCompile=true
+
+jobs:
+  nightly:
+    name: Build and publish Enterprise nightly bundle to Firebase
+    runs-on: ubuntu-latest
+    if: ${{ github.repository == 'element-hq/element-x-android' }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Add SSH private keys for submodule repositories
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
+      - name: Clone submodules
+        run: git submodule update --init --recursive
+      - name: Use JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin' # See 'Supported distributions' for available options
+          java-version: '17'
+      - name: Build and upload Nightly application
+        run: |
+          ./gradlew assembleGplayNightly appDistributionUploadGplayNightly $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/gplay/nightly/app-gplay-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/quality.yml

@@ -18,6 +18,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Add SSH private keys for submodule repositories
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
+      - name: Clone submodules
+        if: github.repository == 'element-hq/element-x-android'
+        run: git submodule update --init --recursive
       - name: Run code quality check suite
         run: ./tools/check/check_code_quality.sh
 
@@ -68,6 +75,13 @@ jobs:
           # Ensure we are building the branch and not the branch after being merged on develop
           # https://github.com/actions/checkout/issues/881
           ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }}
+      - name: Add SSH private keys for submodule repositories
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
+      - name: Clone submodules
+        if: github.repository == 'element-hq/element-x-android'
+        run: git submodule update --init --recursive
       - name: Use JDK 17
         uses: actions/setup-java@v4
         with:
@@ -100,6 +114,13 @@ jobs:
           # Ensure we are building the branch and not the branch after being merged on develop
           # https://github.com/actions/checkout/issues/881
           ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }}
+      - name: Add SSH private keys for submodule repositories
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
+      - name: Clone submodules
+        if: github.repository == 'element-hq/element-x-android'
+        run: git submodule update --init --recursive
       - name: Use JDK 17
         uses: actions/setup-java@v4
         with:
@@ -136,6 +157,13 @@ jobs:
           # Ensure we are building the branch and not the branch after being merged on develop
           # https://github.com/actions/checkout/issues/881
           ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }}
+      - name: Add SSH private keys for submodule repositories
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
+      - name: Clone submodules
+        if: github.repository == 'element-hq/element-x-android'
+        run: git submodule update --init --recursive
       - name: Use JDK 17
         uses: actions/setup-java@v4
         with:
@@ -168,6 +196,13 @@ jobs:
           # Ensure we are building the branch and not the branch after being merged on develop
           # https://github.com/actions/checkout/issues/881
           ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }}
+      - name: Add SSH private keys for submodule repositories
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
+      - name: Clone submodules
+        if: github.repository == 'element-hq/element-x-android'
+        run: git submodule update --init --recursive
       - name: Use JDK 17
         uses: actions/setup-java@v4
         with:
@@ -200,6 +235,13 @@ jobs:
           # Ensure we are building the branch and not the branch after being merged on develop
           # https://github.com/actions/checkout/issues/881
           ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }}
+      - name: Add SSH private keys for submodule repositories
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
+      - name: Clone submodules
+        if: github.repository == 'element-hq/element-x-android'
+        run: git submodule update --init --recursive
       - name: Use JDK 17
         uses: actions/setup-java@v4
         with:
@@ -245,7 +287,7 @@ jobs:
           yarn add danger-plugin-lint-report --dev
       - name: Danger lint
         if: always()
-        uses: danger/[email protected].2
+        uses: danger/[email protected].3
         with:
           args: "--dangerfile ./tools/danger/dangerfile-lint.js"
         env: