From 114c8b615d13215f97a2dcced4cfa2832e86d2e4 Mon Sep 17 00:00:00 2001 From: "B. Petersen" Date: Fri, 6 Mar 2020 23:48:30 +0100 Subject: [PATCH] update checklists --- docs/release-checklist.md | 106 +++++++++++++++++++++++--------------- docs/testing-checklist.md | 12 +++++ 2 files changed, 76 insertions(+), 42 deletions(-) create mode 100644 docs/testing-checklist.md diff --git a/docs/release-checklist.md b/docs/release-checklist.md index ab46bce1f..6a8f55093 100644 --- a/docs/release-checklist.md +++ b/docs/release-checklist.md @@ -1,46 +1,68 @@ +# Release checklist - generate APK + +on the command-line: + +1. update core rust submodule, if needed: + $ ./tools/update-core.sh + $ ./tools/clean-core.sh # to be sure nothing gets mixed up + +2. $ ./ndk-make.sh + +this will take some time - meanwhile we're doing some housekeeping: + +3. update translations and local help: + $ ./tools/tx-pull-translations.sh + $ cd ../deltachat-pages; ./tools/create-local-help.py; cd ../deltachat-ios + +4. update CHANGELOG.md + (the core-changelog at + https://github.com/deltachat/deltachat-core-rust/blob/master/CHANGELOG.md + and the "N commits to master since last release" on + https://github.com/deltachat/deltachat-android/releases gives some hints) + +in Android Studio: + +5. bump version in gradle.build, + update _both_, versionCode and versionName + +6. if `./ndk-make.sh` from step 2. is finished successfully: + a) select "Build / Generate signed APK" + (not: App Bundle as this would require uploading the signing key) + b) select flavor `gplayRelease` with V1 signature enabled + (needed for easy APK verification), V2 is optional + +on success, the generated APK is at +`gplay/release/deltachat-gplay-release-VERSION.apk` + + +# Upload APK to get.delta.chat + +7. $ cd gplay/release + $ rsync deltachat-gplay-release-VERSION.apk jekyll@download.delta.chat:/var/www/html/download/android/ + (you need the private SSH key of the jekyll user; you can find it in this file: + https://github.com/hpk42/otf-deltachat/blob/master/secrets/delta.chat + It is protected with [git-crypt](https://www.agwa.name/projects/git-crypt/) - + after installing it, you can decrypt it with `git crypt unlock`. + If your key isn't added to the secrets, you can ask on irc add you. + Add the key to your `~/.ssh/config` for the host, or to your ssh-agent, so rsync is able to use it) + + +# Release on Play Store + +on https://play.google.com/apps/publish/ : + +8. a) open "Delta Chat/Release management/App releases/Open track/Manage" + then "Create release/Browse files" and select APK from above + b) fill out "What's new in this release?" (500 characters max) + c) click "Save" and then "Review" + d) rollout to 20% by default is fine + # Release new F-Droid version -Release core, if needed, then: - -1. $ git checkout master -2. $ ./tools/update-core.sh -3. $ ./tools/tx-pull-translations.sh # test and commit changes -4. bump version, adapt changelog, commit, push -5. deltachat-android on Github: "Draft a new release" with the version form `v1.2.3` - -... some days later, F-Droid should be updated. +9. make sure, everything is pushed, then: + $ git tag v1.2.1; git push --tags + +F-Droid picks on the tags starting with "v" and builds the version. +This may take some days. -# Release new APK and Play Store version - -Release core, f-droid, then: - -1. make sure latest core is used: ./ndk-make -2. In Android Studio, select "Build / Generate signed APK" - (not: App Bundle as this would require uploading the signing key to Google) -3. Select flavor `gplayRelease` with V1 signature enabled - (needed for easy APK verification), V2 is optional -4. Upload the generated APK from `gplay/release` to download.delta.chat. - You need the private SSH key of the jekyll user; you can find it in this file: https://github.com/hpk42/otf-deltachat/blob/master/secrets/delta.chat - It is protected with [git-crypt](https://www.agwa.name/projects/git-crypt/) - after installing it, you can decrypt it with `git crypt unlock`. - If your key isn't added to the secrets, you can ask missytake@systemli.org to add you. - Add the key to your `~/.ssh/config` for the host, or to your ssh-agent, so rsync is able to use it. - - `cd gplay/release` - - `rsync deltachat-gplay-release-0.*.apk jekyll@download.delta.chat:/var/www/html/download/android/` -5. Test the APK -6. Upload the APK as _Beta_ (_not:_ Production) to https://play.google.com/apps/publish/ - (Release management/App releases/Open track/Manage/Create Release/Browse files -> - select APK from above, add changelog -> Review button, then "ok" or so) - -# Testing checklist - -Only some rough ideas, ideally, this should result into a simple checklist -that can be checked before releasing. -However, although it would be nice to test "everything", we should keep in mind -that the test should be doable in, say, 10~15 minutes. -- create new account with (one of?): gmail, yandex, other - or (?) test an existing account -- send and receive a message -- create a group -- do a contact verification -- join a group via a qr scan diff --git a/docs/testing-checklist.md b/docs/testing-checklist.md new file mode 100644 index 000000000..ca4b8db0e --- /dev/null +++ b/docs/testing-checklist.md @@ -0,0 +1,12 @@ +# Testing checklist + +Only some rough ideas, ideally, this should result into a simple checklist +that can be checked before releasing. +However, although it would be nice to test "everything", we should keep in mind +that the test should be doable in, say, 10~15 minutes. +- create new account with (one of?): gmail, yandex, other + or (?) test an existing account +- send and receive a message +- create a group +- do a contact verification +- join a group via a qr scan