Merge pull request #7579 from element-hq/feature/bma/improveReleaseScript

Add releaseV2.sh, a release script automating the GitHub release

.github/workflows/release.yml

@@ -63,44 +63,6 @@ jobs:
           path: |
             app/build/outputs/bundle/gplayRelease/app-gplay-release.aab
 
-  enterprise:
-    name: Create App Bundle Enterprise
-    runs-on: ubuntu-latest
-    if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == 'element-hq/element-x-android' }}
-    concurrency:
-      group: ${{ format('build-release-main-enterprise-{0}', github.sha) }}
-      cancel-in-progress: true
-    steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        with:
-          persist-credentials: false
-      - name: Add SSH private keys for submodule repositories
-        uses: webfactory/ssh-agent@e83874834305fe9a4a2997156cb26c5de65a8555 # v0.10.0
-        if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == 'element-hq/element-x-android' }}
-        with:
-          ssh-private-key: ${{ secrets.ELEMENT_ENTERPRISE_DEPLOY_KEY }}
-      - name: Clone submodules
-        run: git submodule update --init --recursive
-      - name: Use JDK 21
-        uses: actions/setup-java@b6effb05e454b25005698d916606bdc6ffcbf961 # v5.7.0
-        with:
-          distribution: 'temurin' # See 'Supported distributions' for available options
-          java-version: '21'
-      - name: Configure gradle
-        uses: gradle/actions/setup-gradle@9c971963bec38e04b3d30dcc455b5382be2fdbfb # v6.3.0
-      - name: Create Enterprise 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 bundleGplayRelease $CI_GRADLE_ARG_PROPERTIES
-      - name: Upload bundle as artifact
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
-        with:
-          name: elementx-enterprise-app-gplay-bundle-unsigned
-          path: |
-            app/build/outputs/bundle/gplayRelease/app-gplay-release.aab
-
   fdroid:
     name: Create APKs (FDroid)
     runs-on: ubuntu-latest

docs/install_from_github_release.md

@@ -64,16 +64,16 @@ brew install bundletool
 ### Steps
 
 1. Open the GitHub release that you want to install from https://github.com/element-hq/element-x-android/releases
-2. Download the asset `app-release-signed.aab`
+2. Download the asset `app-gplay-release-signed.aab`
 3. Navigate to the folder where you cloned the project and run the following command:
 ```bash
-bundletool build-apks --bundle=<PATH_TO_YOUR_APP-RELEASE-SIGNED.AAB_FILE> --output=./tmp/elementx.apks \
+bundletool build-apks --bundle=<PATH_TO_YOUR_APP-GPLAY-RELEASE-SIGNED.AAB_FILE> --output=./tmp/elementx.apks \
       --ks=./app/signature/debug.keystore --ks-pass=pass:android --ks-key-alias=androiddebugkey --key-pass=pass:android \
       --overwrite
 ```
 For instance:
 ```bash
-bundletool build-apks --bundle=./tmp/Element/0.1.5/app-release-signed.aab --output=./tmp/elementx.apks \ 
+bundletool build-apks --bundle=./tmp/Element/26.08.3/app-gplay-release-signed.aab --output=./tmp/elementx.apks \
       --ks=./app/signature/debug.keystore --ks-pass=pass:android --ks-key-alias=androiddebugkey --key-pass=pass:android \
       --overwrite
 ```

tools/release/releaseV2.sh

@@ -0,0 +1,541 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2026 Element Creations Ltd.
+#
+# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+# Please see LICENSE files in the repository root for full details.
+
+# do not exit when any command fails (issue with git flow)
+set +e
+
+printf "\n================================================================================\n"
+printf "|                  Welcome to the release script (V2)!                         |\n"
+printf "================================================================================\n"
+
+printf "Checking environment...\n"
+envError=0
+
+# Check that bundletool is installed
+if ! command -v bundletool &> /dev/null
+then
+    printf "Fatal: bundletool is not installed. You can install it running \`brew install bundletool\`\n"
+    envError=1
+fi
+
+# Check that the GitHub CLI is installed. It is expected to be already authenticated, see `gh auth login`.
+if ! command -v gh &> /dev/null
+then
+    printf "Fatal: gh (the GitHub CLI) is not installed. You can install it running \`brew install gh\`\n"
+    envError=1
+fi
+
+# Path of the key store (it's a file)
+keyStorePath="${ELEMENT_X_KEYSTORE_PATH}"
+if [[ -z "${keyStorePath}" ]]; then
+    printf "Fatal: ELEMENT_X_KEYSTORE_PATH is not defined in the environment.\n"
+    envError=1
+fi
+# Keystore password
+keyStorePassword="${ELEMENT_X_KEYSTORE_PASSWORD}"
+if [[ -z "${keyStorePassword}" ]]; then
+    printf "Fatal: ELEMENT_X_KEYSTORE_PASSWORD is not defined in the environment.\n"
+    envError=1
+fi
+# Key password
+keyPassword="${ELEMENT_X_KEY_PASSWORD}"
+if [[ -z "${keyPassword}" ]]; then
+    printf "Fatal: ELEMENT_X_KEY_PASSWORD is not defined in the environment.\n"
+    envError=1
+fi
+# Android home
+androidHome="${ANDROID_HOME}"
+if [[ -z "${androidHome}" ]]; then
+    printf "Fatal: ANDROID_HOME is not defined in the environment.\n"
+    envError=1
+fi
+# @elementbot:matrix.org matrix token / Not mandatory
+elementBotToken="${ELEMENT_BOT_MATRIX_TOKEN}"
+if [[ -z "${elementBotToken}" ]]; then
+    printf "Warning: ELEMENT_BOT_MATRIX_TOKEN is not defined in the environment.\n"
+fi
+
+if [ ${envError} == 1 ]; then
+  exit 1
+fi
+
+# Handle the result of a version check. ${checkError} must be set to 1 when a check has failed.
+checkVersionResult() {
+  if [[ ${checkError} -ne 0 ]]; then
+    printf "\nThe check above has failed, this is not expected.\n"
+    read -r -p "Do you want to continue anyway (yes/no) default to no? " doContinue
+    doContinue=${doContinue:-no}
+    if [ "${doContinue}" != "yes" ]; then
+      exit 1
+    fi
+  else
+    printf "The versions are correct.\n"
+  fi
+}
+
+# Read minSdkVersion from file plugins/src/main/kotlin/Versions.kt
+minSdkVersion=$(grep "MIN_SDK_FOSS =" ./plugins/src/main/kotlin/Versions.kt |cut -d '=' -f 2 |xargs)
+# Read buildToolsVersion from file plugins/src/main/kotlin/Versions.kt
+buildToolsVersion=$(grep "BUILD_TOOLS_VERSION =" ./plugins/src/main/kotlin/Versions.kt |cut -d '=' -f 2 |xargs)
+buildToolsPath="${androidHome}/build-tools/${buildToolsVersion}"
+
+if [[ ! -d ${buildToolsPath} ]]; then
+    printf "Fatal: %s folder not found, ensure that you have installed the SDK version %s.\n" "${buildToolsPath}" "${buildToolsVersion}"
+    exit 1
+fi
+
+# Check if git flow is enabled
+gitFlowDevelop=$(git config gitflow.branch.develop)
+if [[ ${gitFlowDevelop} != "" ]]
+then
+    printf "Git flow is initialized\n"
+else
+    printf "Git flow is not initialized. Initializing...\n"
+    ./tools/gitflow/gitflow-init.sh
+fi
+
+printf "OK\n"
+
+printf "\n================================================================================\n"
+printf "Ensuring main and develop branches are up to date...\n"
+
+git checkout main
+git pull
+git checkout develop
+git pull
+
+printf "\n================================================================================\n"
+# Guessing version to propose a default version
+versionsFile="./plugins/src/main/kotlin/Versions.kt"
+# The version of the release must match the date of next monday, where the release is supposed to go live
+# The command below gets the date of next monday
+nextMondayDateCommand="date -v +1w -v -monday"
+# Get release year on 2 digits
+versionYearCandidate=$(${nextMondayDateCommand} +%y)
+currentVersionMonth=$(grep "val versionMonth" ${versionsFile} | cut  -d " " -f6)
+# Get release month on 2 digits
+versionMonthCandidate=$(${nextMondayDateCommand} +%m)
+versionMonthCandidateNoLeadingZero=${versionMonthCandidate/#0/}
+currentVersionReleaseNumber=$(grep "val versionReleaseNumber" ${versionsFile} | cut  -d " " -f6)
+# if the release month is the same as the current version, we increment the release number, else we reset it to 0
+if [[ ${currentVersionMonth} -eq ${versionMonthCandidateNoLeadingZero} ]]; then
+  versionReleaseNumberCandidate=$((currentVersionReleaseNumber + 1))
+else
+  versionReleaseNumberCandidate=0
+fi
+versionCandidate="${versionYearCandidate}.${versionMonthCandidate}.${versionReleaseNumberCandidate}"
+
+read -r -p "Please enter the release version (example: ${versionCandidate}). Format must be 'YY.MM.x' or 'YY.MM.xy', with year and month matching next Monday. Just press enter if ${versionCandidate} is correct. " version
+version=${version:-${versionCandidate}}
+
+# extract year, month and release number for future use
+versionYear=$(echo "${version}" | cut  -d "." -f1)
+versionMonth=$(echo "${version}" | cut  -d "." -f2)
+versionMonthNoLeadingZero=${versionMonth/#0/}
+versionReleaseNumber=$(echo "${version}" | cut  -d "." -f3)
+
+printf "\n================================================================================\n"
+printf "Starting the release %s\n" "${version}"
+git flow release start "${version}"
+
+# Note: in case the release is already started and the script is started again, checkout the release branch again.
+ret=$?
+if [[ $ret -ne 0 ]]; then
+  printf "Mmh, it seems that the release is already started. I'm displaying the changes now:\n"
+  git diff --stat "release/${version}" origin/main
+  printf "Do you want to continue the release using its contents?\n\n"
+  read -r -p "Continue (yes/no) default to yes? " doContinue
+  doContinue=${doContinue:-yes}
+  if [ "${doContinue}" == "no" ]; then
+    printf "OK, exiting, you can start the release again with the command 'git flow release start %s'\n" "${version}"
+    exit 1
+  fi
+  git checkout "release/${version}"
+fi
+
+# Ensure version is OK
+versionsFileBak="${versionsFile}.bak"
+cp ${versionsFile} ${versionsFileBak}
+sed "s/private const val versionYear = .*/private const val versionYear = ${versionYear}/" ${versionsFileBak} > ${versionsFile}
+sed "s/private const val versionMonth = .*/private const val versionMonth = ${versionMonthNoLeadingZero}/" ${versionsFile}    > ${versionsFileBak}
+sed "s/private const val versionReleaseNumber = .*/private const val versionReleaseNumber = ${versionReleaseNumber}/" ${versionsFileBak} > ${versionsFile}
+rm ${versionsFileBak}
+
+printf -v versionReleaseNumber2Digits "%02d" "${versionReleaseNumber}"
+versionCode="20${versionYear}${versionMonth}${versionReleaseNumber2Digits}0"
+
+# Update the file aaptDump.txt with the new version
+aaptDumpFile="./tools/manifest/gplay/release/aaptDump.txt"
+sed "s/versionCode='[0-9]*'/versionCode='${versionCode}'/" ${aaptDumpFile} > ${aaptDumpFile}.bak
+sed "s/versionName='[0-9]*\.[0-9]*\.[0-9]*'/versionName='${version}'/" ${aaptDumpFile}.bak > ${aaptDumpFile}
+rm ${aaptDumpFile}.bak
+
+git commit -a -m "Setting version for the release ${version}"
+
+printf "\n================================================================================\n"
+printf "Creating fastlane file...\n"
+fastlaneFile="${versionCode}.txt"
+fastlanePathFile="./fastlane/metadata/android/en-US/changelogs/${fastlaneFile}"
+printf "Main changes in this version: bug fixes and improvements.\nFull changelog: https://github.com/element-hq/element-x-android/releases" > "${fastlanePathFile}"
+
+read -r -p "I have created the file ${fastlanePathFile}, please edit it and press enter to continue. "
+git add "${fastlanePathFile}"
+git commit -a -m "Adding fastlane file for version ${version}"
+
+printf "\n================================================================================\n"
+printf "OK, finishing the release...\n"
+git flow release finish "${version}"
+
+printf "\n================================================================================\n"
+read -r -p "Done, push the branch 'main' and the new tag (yes/no) default to yes? " doPush
+doPush=${doPush:-yes}
+
+if [ "${doPush}" == "yes" ]; then
+  printf "Pushing branch 'main' and tag 'v%s'...\n" "${version}"
+  git push origin main
+  git push origin "v${version}"
+else
+    printf "Not pushing, do not forget to push manually!\n"
+fi
+
+printf "\n================================================================================\n"
+printf "Checking out develop...\n"
+git checkout develop
+
+printf "\n================================================================================\n"
+printf "Downloading the artifacts...\n"
+
+targetPath="./tmp/Element/${version}"
+fdroidTargetPath="${targetPath}/fdroid"
+gplayTargetPath="${targetPath}/gplay"
+
+releaseCommit=$(git rev-parse --verify --quiet "v${version}^{commit}")
+if [[ -z "${releaseCommit}" ]]; then
+  # Without a commit, `gh run list` would return the latest run of the workflow, which may be another one.
+  printf "Fatal: the tag v%s cannot be resolved.\n" "${version}"
+  exit 1
+fi
+
+printf "Looking for the run of the workflow release.yml for the commit %s...\n" "${releaseCommit}"
+
+runId=""
+
+# The run can take a few seconds to appear after the push, so retry for a couple of minutes.
+for _ in $(seq 1 12); do
+  runId=$(gh run list --repo element-hq/element-x-android --workflow release.yml --commit "${releaseCommit}" --limit 1 --json databaseId -q '.[0].databaseId' 2> /dev/null)
+  if [[ -n "${runId}" ]]; then
+    break
+  fi
+  printf "No run found yet, waiting...\n"
+  sleep 10
+done
+
+if [[ -z "${runId}" ]]; then
+  printf "Fatal: no run of the workflow release.yml found for the commit %s.\n" "${releaseCommit}"
+  exit 1
+fi
+
+printf "Found the run https://github.com/element-hq/element-x-android/actions/runs/%s\n" "${runId}"
+printf "Waiting for the run to complete...\n"
+gh run watch "${runId}" --repo element-hq/element-x-android --compact --exit-status
+
+ret=1
+
+while [[ $ret -ne 0 ]]; do
+  gh run download "${runId}" --repo element-hq/element-x-android \
+     --dir "${gplayTargetPath}" \
+     --name elementx-app-gplay-bundle-unsigned
+
+  ret=$?
+  if [[ $ret -eq 0 ]]; then
+    gh run download "${runId}" --repo element-hq/element-x-android \
+       --dir "${fdroidTargetPath}" \
+       --name elementx-app-fdroid-apks-unsigned
+
+    ret=$?
+  fi
+  if [[ $ret -ne 0 ]]; then
+    read -r -p "Error while downloading the artifacts. You may want to fix the issue and retry. Retry (yes/no) default to yes? " doRetry
+    doRetry=${doRetry:-yes}
+    if [ "${doRetry}" == "no" ]; then
+      exit 1
+    fi
+  fi
+done
+
+printf "\n================================================================================\n"
+printf "Signing the FDroid APKs...\n"
+
+cp "${fdroidTargetPath}"/app-fdroid-arm64-v8a-release.apk \
+   "${fdroidTargetPath}"/app-fdroid-arm64-v8a-release-signed.apk
+"${buildToolsPath}"/apksigner sign \
+       -v \
+       --alignment-preserved true \
+       --ks "${keyStorePath}" \
+       --ks-pass pass:"${keyStorePassword}" \
+       --ks-key-alias elementx \
+       --key-pass pass:"${keyPassword}" \
+       --min-sdk-version "${minSdkVersion}" \
+       "${fdroidTargetPath}"/app-fdroid-arm64-v8a-release-signed.apk
+
+cp "${fdroidTargetPath}"/app-fdroid-armeabi-v7a-release.apk \
+   "${fdroidTargetPath}"/app-fdroid-armeabi-v7a-release-signed.apk
+"${buildToolsPath}"/apksigner sign \
+       -v \
+       --alignment-preserved true \
+       --ks "${keyStorePath}" \
+       --ks-pass pass:"${keyStorePassword}" \
+       --ks-key-alias elementx \
+       --key-pass pass:"${keyPassword}" \
+       --min-sdk-version "${minSdkVersion}" \
+       "${fdroidTargetPath}"/app-fdroid-armeabi-v7a-release-signed.apk
+
+cp "${fdroidTargetPath}"/app-fdroid-x86-release.apk \
+   "${fdroidTargetPath}"/app-fdroid-x86-release-signed.apk
+"${buildToolsPath}"/apksigner sign \
+       -v \
+       --alignment-preserved true \
+       --ks "${keyStorePath}" \
+       --ks-pass pass:"${keyStorePassword}" \
+       --ks-key-alias elementx \
+       --key-pass pass:"${keyPassword}" \
+       --min-sdk-version "${minSdkVersion}" \
+       "${fdroidTargetPath}"/app-fdroid-x86-release-signed.apk
+
+cp "${fdroidTargetPath}"/app-fdroid-x86_64-release.apk \
+   "${fdroidTargetPath}"/app-fdroid-x86_64-release-signed.apk
+"${buildToolsPath}"/apksigner sign \
+       -v \
+       --alignment-preserved true \
+       --ks "${keyStorePath}" \
+       --ks-pass pass:"${keyStorePassword}" \
+       --ks-key-alias elementx \
+       --key-pass pass:"${keyPassword}" \
+       --min-sdk-version "${minSdkVersion}" \
+       "${fdroidTargetPath}"/app-fdroid-x86_64-release-signed.apk
+
+printf "\n================================================================================\n"
+printf "Checking the signed APKs...\n"
+
+checkError=0
+
+# Each APK gets the version code of the app bundle, plus the code of its ABI.
+# Must be kept in sync with the abiVersionCodes map in app/build.gradle.kts.
+fdroidAbis="armeabi-v7a:1 arm64-v8a:2 x86:3 x86_64:4"
+
+for abiEntry in ${fdroidAbis}; do
+  abi="${abiEntry%%:*}"
+  abiCode="${abiEntry##*:}"
+  expectedApkVersionCode=$((versionCode + abiCode))
+  apkFile="${fdroidTargetPath}/app-fdroid-${abi}-release-signed.apk"
+  apkBadging=$("${buildToolsPath}"/aapt dump badging "${apkFile}" | grep -m 1 "^package")
+  apkVersionCode=$(printf "%s" "${apkBadging}" | sed -n "s/.*versionCode='\([0-9]*\)'.*/\1/p")
+  apkVersionName=$(printf "%s" "${apkBadging}" | sed -n "s/.*versionName='\([^']*\)'.*/\1/p")
+  printf "File app-fdroid-%s-release-signed.apk: version code %s, version name %s\n" "${abi}" "${apkVersionCode}" "${apkVersionName}"
+  if [[ "${apkVersionCode}" != "${expectedApkVersionCode}" ]]; then
+    printf "Warning: was expecting the version code %s, but got %s.\n" "${expectedApkVersionCode}" "${apkVersionCode}"
+    checkError=1
+  fi
+  if [[ "${apkVersionName}" != "${version}" ]]; then
+    printf "Warning: was expecting the version name %s, but got %s.\n" "${version}" "${apkVersionName}"
+    checkError=1
+  fi
+done
+
+checkVersionResult
+
+printf "\n================================================================================\n"
+printf "The APKs in %s have been signed!\n" "${fdroidTargetPath}"
+
+unsignedBundlePath="${gplayTargetPath}/app-gplay-release.aab"
+signedBundlePath="${gplayTargetPath}/app-gplay-release-signed.aab"
+# The universal APK is downloaded manually from the GooglePlay console, and is named after the version code.
+universalApkPath="${gplayTargetPath}/${versionCode}.apk"
+
+printf "\n================================================================================\n"
+printf "Signing file %s with build-tools version %s for min SDK version %s...\n" "${unsignedBundlePath}" "${buildToolsVersion}" "${minSdkVersion}"
+
+cp "${unsignedBundlePath}" "${signedBundlePath}"
+
+"${buildToolsPath}"/apksigner sign \
+    -v \
+    --ks "${keyStorePath}" \
+    --ks-pass pass:"${keyStorePassword}" \
+    --ks-key-alias elementx \
+    --key-pass pass:"${keyPassword}" \
+    --min-sdk-version "${minSdkVersion}" \
+    "${signedBundlePath}"
+
+printf "\n================================================================================\n"
+printf "Checking the signed app bundle...\n"
+
+checkError=0
+
+bundleVersionCode=$(bundletool dump manifest --bundle="${signedBundlePath}" --xpath=/manifest/@android:versionCode)
+bundleVersionName=$(bundletool dump manifest --bundle="${signedBundlePath}" --xpath=/manifest/@android:versionName)
+printf "File %s: version code %s, version name %s\n" "$(basename "${signedBundlePath}")" "${bundleVersionCode}" "${bundleVersionName}"
+if [[ "${bundleVersionCode}" != "${versionCode}" ]]; then
+  printf "Warning: was expecting the version code %s, but got %s.\n" "${versionCode}" "${bundleVersionCode}"
+  checkError=1
+fi
+if [[ "${bundleVersionName}" != "${version}" ]]; then
+  printf "Warning: was expecting the version name %s, but got %s.\n" "${version}" "${bundleVersionName}"
+  checkError=1
+fi
+
+checkVersionResult
+
+printf "\n================================================================================\n"
+printf "The file %s has been signed and can be uploaded to the PlayStore!\n" "${signedBundlePath}"
+
+printf "\n================================================================================\n"
+read -r -p "Do you want to build the APKs from the app bundle? You need to do this step if you want to install the application to your device. (yes/no) default to no " doBuildApks
+doBuildApks=${doBuildApks:-no}
+
+if [ "${doBuildApks}" == "yes" ]; then
+  printf "Building apks...\n"
+  bundletool build-apks --bundle="${signedBundlePath}" --output="${gplayTargetPath}"/elementx.apks \
+      --ks=./app/signature/debug.keystore --ks-pass=pass:android --ks-key-alias=androiddebugkey --key-pass=pass:android \
+      --overwrite
+
+  read -r -p "Do you want to install the application to your device? Make sure there is one (and only one!) connected device first. (yes/no) default to yes " doDeploy
+  doDeploy=${doDeploy:-yes}
+  if [ "${doDeploy}" == "yes" ]; then
+    printf "Installing apk for your device...\n"
+    bundletool install-apks --apks="${gplayTargetPath}"/elementx.apks
+    read -r -p "Please run the application on your phone to check that the upgrade went well. Press enter to continue. "
+  else
+    printf "APK will not be deployed!\n"
+  fi
+else
+  printf "APKs will not be generated!\n"
+fi
+
+printf "\n================================================================================\n"
+printf "Create the open testing release on GooglePlay.\n"
+
+printf "On GooglePlay console, go the the open testing section and click on \"Create new release\" button, then:\n"
+printf " - upload the file %s.\n" "${signedBundlePath}"
+printf " - copy the release note from the fastlane file.\n"
+printf " - download the universal APK, to be able to provide it to the GitHub release: click on the right arrow next to the \"App bundle\", then click on the \"Download\" tab, and download the \"Signed, universal APK\". Save it, without renaming it, to the folder %s. The expected final path is %s\n" "${gplayTargetPath}" "${universalApkPath}"
+printf " - submit the release.\n"
+read -r -p "Press enter to continue. "
+
+printf "You can then go to \"Publishing overview\" and send the new release for a review by Google.\n"
+read -r -p "Press enter to continue. "
+
+printf "\n================================================================================\n"
+printf "Creating the release on GitHub.\n"
+
+releaseAssets=(
+  "${signedBundlePath}"
+  "${universalApkPath}"
+  "${fdroidTargetPath}/app-fdroid-arm64-v8a-release-signed.apk"
+  "${fdroidTargetPath}/app-fdroid-armeabi-v7a-release-signed.apk"
+  "${fdroidTargetPath}/app-fdroid-x86-release-signed.apk"
+  "${fdroidTargetPath}/app-fdroid-x86_64-release-signed.apk"
+)
+
+missingAsset=0
+
+for releaseAsset in "${releaseAssets[@]}"; do
+  if [[ ! -f "${releaseAsset}" ]]; then
+    printf "Error: the file %s does not exist.\n" "${releaseAsset}"
+    missingAsset=1
+  fi
+done
+
+if [[ ${missingAsset} -ne 0 ]]; then
+  printf "Fatal: some files are missing, cannot create the GitHub release.\n"
+  exit 1
+fi
+
+printf "Creating the pre-release v%s and uploading the %d files, this can take a while...\n" "${version}" "${#releaseAssets[@]}"
+gh release create "v${version}" \
+   --repo element-hq/element-x-android \
+   --title "Element X Android v${version}" \
+   --generate-notes \
+   --prerelease \
+   --verify-tag \
+   "${releaseAssets[@]}"
+
+if [[ $? -ne 0 ]]; then
+  printf "Fatal: error while creating the GitHub release.\n"
+  exit 1
+fi
+
+printf "The pre-release has been created: https://github.com/element-hq/element-x-android/releases/tag/v%s\n" "${version}"
+printf "Please check the generated release notes, and optionally reorder items and fix typos.\n"
+read -r -p "Press enter to continue. "
+
+printf "\n================================================================================\n"
+printf "Update the project release notes:\n\n"
+
+printf "Getting the release notes from GitHub...\n"
+releaseNotes=$(gh release view "v${version}" --repo element-hq/element-x-android --json body -q .body)
+
+if [[ $? -ne 0 || -z "${releaseNotes}" ]]; then
+  printf "Fatal: error while getting the release notes from GitHub.\n"
+  exit 1
+fi
+
+# GitHub returns the release notes with CRLF line endings, remove the CR.
+releaseNotes="${releaseNotes//$'\r'/}"
+changesTitle="Changes in Element X v${version}"
+# Underline the title with as many '=' as there are characters in the title.
+changesUnderline="${changesTitle//?/=}"
+changesFile="./CHANGES.md"
+changesFileBak="${changesFile}.bak"
+mv "${changesFile}" "${changesFileBak}"
+{
+  printf "%s\n%s\n\n" "${changesTitle}" "${changesUnderline}"
+  printf "%s\n\n" "${releaseNotes}"
+  cat "${changesFileBak}"
+} > "${changesFile}"
+rm "${changesFileBak}"
+printf "The file CHANGES.md has been updated.\n"
+read -r -p "Please check the change and press enter to commit it. "
+
+printf "\n================================================================================\n"
+printf "Committing...\n"
+git commit -a -m "Changelog for version ${version}"
+
+printf "\n================================================================================\n"
+read -r -p "Done, push the branch 'develop' (yes/no) default to yes? (A rebase may be necessary in case develop got new commits) " doPush
+doPush=${doPush:-yes}
+
+if [ "${doPush}" == "yes" ]; then
+  printf "Pushing branch 'develop'...\n"
+  git push origin develop
+else
+    printf "Not pushing, do not forget to push manually!\n"
+fi
+
+printf "\n================================================================================\n"
+printf "Message for the Android internal room:\n\n"
+message="@room Element X Android ${version} is ready to be tested. You can get it from https://github.com/element-hq/element-x-android/releases/tag/v${version}. You can install the universal APK. If you want to install the application from the app bundle, you can follow instructions [here](https://github.com/element-hq/element-x-android/blob/develop/docs/install_from_github_release.md). Please report any feedback. Thanks!"
+printf "%s\n\n" "${message}"
+
+if [[ -z "${elementBotToken}" ]]; then
+  read -r -p "ELEMENT_BOT_MATRIX_TOKEN is not defined in the environment. Cannot send the message for you. Please send it manually, and press enter to continue. "
+else
+  read -r -p "Send this message to the room (yes/no) default to yes? " doSend
+  doSend=${doSend:-yes}
+  if [ "${doSend}" == "yes" ]; then
+    printf "Sending message...\n"
+    transactionId=$(openssl rand -hex 16)
+    # Element Android internal
+    matrixRoomId="!LiSLXinTDCsepePiYW:matrix.org"
+    curl -X PUT --data "{\"msgtype\":\"m.text\",\"body\":\"${message}\"}" -H "Authorization: Bearer ${elementBotToken}" https://matrix-client.matrix.org/_matrix/client/r0/rooms/${matrixRoomId}/send/m.room.message/\$local."${transactionId}"
+  else
+    printf "Message not sent, please send it manually!\n"
+  fi
+fi
+
+printf "\n================================================================================\n"
+printf "Congratulation! Kudos for using this script! Have a nice day!\n"
+printf "================================================================================\n"