Merge branch 'release/tchap_v2.4.0'

.github/ISSUE_TEMPLATE/bug.yml

@@ -73,3 +73,14 @@ body:
         - 'No'
     validations:
       required: true
+  - type: dropdown
+    id: pr
+    attributes:
+      label: Are you willing to provide a PR?
+      description:  |
+        Providing a PR can drastically speed up the process of fixing this bug. Don't worry, it's still OK to answer 'No' :).
+      options:
+        - 'Yes'
+        - 'No'
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -34,3 +34,14 @@ body:
       placeholder: Is there anything else you'd like to add?
     validations:
       required: false
+  - type: dropdown
+    id: pr
+    attributes:
+      label: Are you willing to provide a PR?
+      description:  |
+        Don't worry, it's still OK to answer 'No' :).
+      options:
+        - 'Yes'
+        - 'No'
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/release.yml

@@ -18,11 +18,13 @@ body:
 
         - [ ] Weblate sync, fix lint issue if any (in a dedicated PR)
         - [ ] Check the update of the store descriptions (using Google Translate if necessary) to ensure that the changes are acceptable to be published to the stores.
+        - [ ] While Weblate is locked, and after the PR from Weblate has been merged, handle all the TODOs in the main `strings.xml` file
         - [ ] Run the script `./tools/release/pushPlayStoreMetaData.sh`. You can check in the GooglePlay console the Activity log to check the effect.
 
         ### Do the release
 
-        - [ ] Create release with gitflow, branch name `release/1.2.3`
+        - [ ] Make sure `develop` and `main` are up to date (git pull)
+        - [ ] Checkout develop and create a release with gitflow, branch name `release/1.2.3`
         - [ ] Check the crashes from the PlayStore
         - [ ] Check the rageshake with the current dev version: https://github.com/matrix-org/element-android-rageshakes/labels/1.2.3-dev
         - [ ] Run the integration test, and especially `UiAllScreensSanityTest.allScreensTest()`
@@ -47,24 +49,34 @@ body:
 
         ### Once tested and validated internally
 
-        - [ ] Create a new beta release on the GooglePlay console and upload the 4 signed Apks.
+        - [ ] Create a new open testing release on the GooglePlay console and upload the 4 signed Apks.
         - [ ] Check that the version codes are correct
         - [ ] Copy the fastlane change to the GooglePlay console in the section en-GB.
-        - [ ] Push to beta release to 100% of the users
-        - [ ] Notify the F-Droid team so that they can schedule the publication on F-Droid
+        - [ ] Push the open testing release to 100% of the users
+        - [ ] Notify the F-Droid team [here](https://matrix.to/#/!LAAuJLQXYHjMNWKrCK:matrix.org?via=matrix.org&via=bubu1.eu&via=lant.uk) so that they can schedule the publication on F-Droid
+        - [ ] The application is available to the PlayStore testers (live). Google can take between 1 hour and up to 7 days to approve the release.
+        - [ ] The application is available to the F-Droid users.
 
-        ### Once Live on PlayStore
+        ### Once open testing is live on PlayStore
 
         - [ ] Ping the Android public room and update its topic
-        - [ ] Add an entry in the internal diary
 
-        ### After at least 2 days
+        ### Once Live on F-Droid
+
+        - [ ] Update the Android public room topic
+
+        ### After at least 2 days (generally next Monday)
 
         - [ ] Check the [rageshakes](https://github.com/matrix-org/element-android-rageshakes/issues)
         - [ ] Check the crash reports on the GooglePlay console
         - [ ] Check the Android Element room for any reported issues on the new version
-        - [ ] If all is OK, push to production and notify Markus (Bubu) to release the F-Droid version
-        - [ ] Ping the Android public room and update its topic with the new available version
+        - [ ] If all is OK, promote the open testing release to production. Generally using a 100% roll out, but can be a smaller value depending on the release content.
+        - [ ] The application is available to the PlayStore users (live). Google can take (again!) between 1 hour and up to 7 days to approve the release.
+
+        ### Once production is live on PlayStore
+
+        - [ ] Ping the Android public room and update its topic
+        - [ ] Add an entry in the internal diary
 
         ### Android SDK2
 
@@ -88,12 +100,20 @@ body:
 
         ##### Release on MavenCentral
 
+        - [ ] Checkout the branch `main`
         - [ ] Run the command `./gradlew publish --no-daemon --no-parallel`. You'll need some non-public element to do so
+        - [ ] Run the command `./gradlew closeAndReleaseRepository`. If it is working well, you can jump directly to the final step of this section.
+
+        If `./gradlew closeAndReleaseRepository` fails (for instance, several repositories are waiting to be handled), you have to close and release the repository manually. Do the following steps:
+
         - [ ] Connect to https://s01.oss.sonatype.org
         - [ ] Click on Staging Repositories and check the the files have been uploaded
         - [ ] Click on close
         - [ ] Wait (check Activity tab until step "Repository closed" is displayed)
         - [ ] Click on release. The staging repository will disappear
+
+        Final step
+
         - [ ] Check that the release is available in https://repo1.maven.org/maven2/org/matrix/android/matrix-android-sdk2/ (it can take a few minutes)
 
         ##### Release on GitHub
@@ -105,7 +125,7 @@ body:
 
         https://github.com/matrix-org/matrix-android-sdk2-sample
 
-        - [ ] Update the dependency to the new version of the SDK2. It can take some time for MavenCentral to make the librarie available. You can check status on https://repo1.maven.org/maven2/org/matrix/android/matrix-android-sdk2/
+        - [ ] Update the dependency to the new version of the SDK2. It can take a few minutes for MavenCentral to make the library available. You can check status on https://repo1.maven.org/maven2/org/matrix/android/matrix-android-sdk2/
         - [ ] Build and run the sample, you may have to fix some API break
         - [ ] Commit and push directly on `main`
     validations:

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,7 +17,17 @@
 
 ## Screenshots / GIFs
 
-<!-- Only if UI have been changed -->
+<!-- Only if UI have been changed
+You can use a table like this to show screenshots comparison.
+Uncomment this markdown table below and edit the last line `|||`:
+|copy screenshot of before here|copy screenshot of after here|
+-->
+
+<!--
+|Before|After|
+|-|-|
+|||
+ -->
 
 ## Tests
 

.github/dependabot.yml

@@ -0,0 +1,29 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Updates for Github Actions used in the repo
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    # Tchap: Disable this script for Tchap
+    open-pull-requests-limit: 0
+    reviewers:
+      - "vector-im/element-android-reviewers"
+    ignore:
+      - dependency-name: "*github-script*"
+  # Updates for Gradle dependencies used in the app
+  - package-ecosystem: gradle
+    directory: "/"
+    schedule:
+      interval: "daily"
+    # Tchap: Disable this script for Tchap
+    open-pull-requests-limit: 0
+    reviewers:
+      - "vector-im/element-android-reviewers"
+    ignore:
+      - dependency-name: com.google.zxing:core

.github/workflows/build.yml

@@ -9,8 +9,9 @@ on:
 # Enrich gradle.properties for CI/CD
 env:
   CI_GRADLE_ARG_PROPERTIES: >
-    -Porg.gradle.jvmargs=-Xmx2g
+    -Porg.gradle.jvmargs=-Xmx4g
     -Porg.gradle.parallel=false
+    --no-daemon
 
 jobs:
   debug:
@@ -20,7 +21,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        target: [ GplayBtchapWithoutvoipWithpinning, FdroidBtchapWithoutvoipWithoutpinning ]
+        target: [ GplayDevTchapWithoutvoipWithoutpinning, FdroidDevTchapWithoutvoipWithoutpinning, GplayBtchapWithvoipWithpinning ]
     # Allow all jobs on develop. Just one per PR.
     concurrency:
       group: ${{ github.ref == 'refs/heads/develop' && format('integration-tests-develop-{0}-{1}', matrix.target, github.sha) || format('build-debug-{0}-{1}', matrix.target, github.ref)  }}
@@ -38,7 +39,7 @@ jobs:
       - name: Assemble ${{ matrix.target }} debug apk
         run: ./gradlew assemble${{ matrix.target }}Debug $CI_GRADLE_ARG_PROPERTIES --stacktrace
       - name: Upload ${{ matrix.target }} debug APKs
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ matrix.target }}-debug
           path: |
@@ -52,8 +53,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        target: [ GplayBtchapWithoutvoipWithpinning, GplayTchapWithoutvoipWithpinning, FdroidBtchapWithoutvoipWithoutpinning, FdroidTchapWithoutvoipWithoutpinning ]
+        target: [ GplayBtchapWithoutvoipWithpinning, GplayTchapWithoutvoipWithpinning, FdroidBtchapWithoutvoipWithoutpinning, FdroidTchapWithoutvoipWithoutpinning, GplayBtchapWithvoipWithpinning ]
     # Only runs on main, no concurrency.
+    concurrency:
+      group: ${{ github.ref == 'refs/head/main' && format('build-release-apk-main-{0}', github.sha) || github.ref == 'refs/heads/develop' && format('build-release-apk-develop-{0}', github.sha) || format('build-debug-{0}', github.ref)  }}
+      cancel-in-progress: ${{ github.ref != 'refs/head/main' }}
     steps:
       - uses: actions/checkout@v3
       - uses: actions/cache@v3
@@ -67,10 +71,32 @@ jobs:
       - name: Assemble ${{ matrix.target }} unsigned apk
         run: ./gradlew clean assemble${{ matrix.target }}Release $CI_GRADLE_ARG_PROPERTIES  --stacktrace
       - name: Upload ${{ matrix.target }} unsigned APKs
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ matrix.target }}-release-unsigned
           path: |
             vector/build/outputs/apk/*/release/*.apk
 
-# TODO: add exodus checks
+  exodus:
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      - name: Obtain apk from artifact
+        id: download
+        uses: actions/download-artifact@v3
+        with:
+          name: vector-gplay-release-unsigned
+      - name: Show apks in artifact
+        run: ls -R ${{steps.download.outputs.download-path}}
+      - name: Execute exodus-standalone
+        uses: docker://exodusprivacy/exodus-standalone:latest
+        with:
+          args: /github/workspace/gplay/release/vector-gplay-universal-release-unsigned.apk -j -o /github/workspace/exodus.json
+      - name: Upload exodus json report
+        uses: actions/upload-artifact@v3
+        with:
+          name: exodus.json
+          path: |
+            exodus.json
+      - name: Check for trackers
+        run: "jq -e '.trackers == []' exodus.json > /dev/null || { echo '::error static analysis identified user tracking library' ; exit 1; }"

.github/workflows/docs.yml

@@ -0,0 +1,22 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ develop ]
+
+jobs:
+  docs:
+    name: Generate and publish Android Matrix SDK documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Build docs
+        run: ./gradlew dokkaHtml
+
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./matrix-sdk-android/build/dokka/html