element-android
element-android copied to clipboard
[Release] Element Android v1.4.32
Release checklist
Before the release
- [x] Weblate sync, fix lint issue if any (in a dedicated PR)
- [x] 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.
- [x] While Weblate is locked, and after the PR from Weblate has been merged, handle all the TODOs in the main
strings.xmlfile - [x] Run the script
./tools/release/pushPlayStoreMetaData.sh. You can check in the GooglePlay console the Activity log to check the effect.
Do the release
- [x] Make sure
developandmainare up to date (git pull) - [x] Checkout develop and create a release with gitflow, branch name
release/1.2.3 - [x] Check the crashes from the PlayStore
- [x] Check the rageshake with the current dev version: https://github.com/matrix-org/element-android-rageshakes/labels/1.2.3-dev
- [x] Run the integration test, and especially
UiAllScreensSanityTest.allScreensTest() - [x] Create an account on matrix.org and do some smoke tests that the sanity test does not cover like: 1-1 call, 1-1 video call, Jitsi call for instance
- [x] Run towncrier:
towncrier build --version v1.2.3 --draft(remove--draftdo write the file CHANGES.md) - [x] Check that the folder
changelog.dis empty. It can happen that some remaining files stay here - [x] Check the file CHANGES.md consistency. It's possible to reorder items (most important changes first) or change their section if relevant. Also an opportunity to fix some typo, or rewrite things
- [x] Add file for fastlane under ./fastlane/metadata/android/en-US/changelogs
- [x] (optional) Push the branch and start a draft PR (will not be merged), to check that the CI is happy with all the changes.
- [x] Finish release with gitflow, delete the draft PR (if created)
- [x] Push
mainand the new tagv1.2.3to origin - [x] Checkout
develop - [x] Increase version (versionPatch + 2) in
./vector/build.gradle - [x] Change the value of SDK_VERSION in the file
./matrix-sdk-android/build.gradle - [x] Commit and push
develop - [x] Wait for Buildkite to build the
mainbranch. - [x] Run the script
~/scripts/releaseElement.sh. It will download the APKs from Buildkite check them and sign them. - [x] Install the APK on your phone to check that the upgrade went well (no init sync, etc.)
- [x] Create the release on gitHub from the tag, copy paste the block from the file CHANGES.md
- [x] Add the 4 signed APKs to the GitHub release
- [x] Ping the Android Internal room
Once tested and validated internally
- [x] Create a new open testing release on the GooglePlay console and upload the 4 signed Apks.
- [x] Check that the version codes are correct
- [x] Copy the fastlane change to the GooglePlay console in the section en-GB.
- [x] Push the open testing release to 100% of the users
- [x] Notify the F-Droid team here 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 open testing is live on PlayStore
- [ ] Ping the Android public room and update its topic
Once Live on F-Droid
- [ ] Update the Android public room topic
After at least 2 days (generally next Monday)
- [ ] Check the rageshakes
- [ ] 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, 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
The SDK2 and the sample app are released only when Element has been pushed to production.
- [ ] Checkout the
mainbranch on Element Android project
On the SDK2 project
https://github.com/matrix-org/matrix-android-sdk2
- [ ] Create a release with GitFlow
- [ ] Update the value of VERSION_NAME in the file gradle.properties
- [ ] Update the files
./build.gradleand./gradle/gradle-wrapper.propertiesmanually, to use the latest version for the dependency. You can get inspired by the same files on Element Android project. - [ ] Run the script
./tools/import_from_element.sh - [ ] Check the diff in the file
./matrix-sdk-android/build.gradleand restore what may have been erased (in particular the lineapply plugin: "com.vanniktech.maven.publish"and the line about the version) - [ ] Let the script finish to build the library
- [ ] Update the file
CHANGES.md - [ ] Finish the release using GitFlow
- [ ] Push the branch
main, the new tag and the branchdevelopto origin
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
- [ ] Create the release on GitHub from the tag
- [ ] Upload the AAR on the GitHub release
Android SDK2 sample
https://github.com/matrix-org/matrix-android-sdk2-sample
- [ ] 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