lori/drip
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add toc, screenshot info and some more

Browse Source
This commit is contained in:
bl00dymarie
2023-11-20 18:04:41 +01:00
parent 92546362a0
commit 4ed399c50c
1 changed files with 45 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
RELEASE.md
+45 -18
View File
@@ -1,15 +1,20 @@
# How to release a new app version for Android # How to release a new app version for Android
Note: You need the release-key for Android to bundle a signed release that can be uploaded and published via the Google Play Store. _Note: You need the release-key for Android to bundle a signed release that can be uploaded and published via the Google Play Store. A similar process for Apple requires a certificate to upload and publish the app to the App Store. More documentation on 'How to release a new app version for iOS' coming soon._
A similar process for Apple requires a certificate to upload and publish the app to the App Store. More documentation on 'How to release a new app version for iOS' coming soon.
1. version updating # Table of Contents
2. android building
3. release sharing 1. [version updating](#Version-updating)
2. [android building](#Building-in-Android)
a. [APK](#APK)
b. [AAB](#AAB)
3. [release sharing](#Share-the-release)
## Version updating ## Version updating
By running the following command, it will: When you are done with a chore, a feature or a bugfix, you may want to share it with testers and eventually publish a release. In order to identify a specific app version we can update the version name, which is created based on the following format: `1.yymm.d` e.g. `1.2311.14`. If you want to upload a new app version to Google Play you also need to update the version code.
The following command will:
- create a new versionName and a new higher versionCode (+1) - create a new versionName and a new higher versionCode (+1)
- create a commit including a tag named after the new release version name. - create a commit including a tag named after the new release version name.
@@ -18,7 +23,9 @@ By running the following command, it will:
yarn release yarn release
``` ```
## Android building The versionName and versionCode [are defined here](https://gitlab.com/bloodyhealth/drip/-/blob/5401789c46f4a02915ab900ef284581be420451c/android/app/build.gradle#L137-138) and in [package.json](https://gitlab.com/bloodyhealth/drip/-/blob/5401789c46f4a02915ab900ef284581be420451c/package.json#L3).
## Building in Android
APK versus AAB APK versus AAB
@@ -29,53 +36,73 @@ APK versus AAB
### APK ### APK
To build a release apk file, run the following command: To build a release apk file, run the following command:
(`cd android && ./gradlew clean && ./gradlew assembleRelease && cd ..`)
``` ```
yarn build-android-apk-release yarn build-android-apk-release
``` ```
It creates a new apk file named app-release.apk under ./android/app/release/ _which is a shortcut for:_ `cd android && ./gradlew clean && ./gradlew assembleRelease && cd ..`
This will create a new apk file named `app-release.apk` under `./android/app/build/outputs/apk/release/`.
For signing an apk you can run this command: For signing an apk you can run this command:
(`zipalign -v -p 4 ./android/app/build/outputs/apk/release/app-release.apk ./android/app/build/outputs/apk/release/app-release_signed.apk`)
``` ```
yarn sign-android-apk-release yarn sign-android-apk-release
``` ```
It adds a file named "app-release_signed.apk" _which is a shortcut for:_ `zipalign -v -p 4 ./android/app/build/outputs/apk/release/app-release.apk ./android/app/build/outputs/apk/release/app-release_signed.apk`
It adds a file name `app-release_signed.apk` in the same folder in `./android/app/build/outputs/apk/release/`
### AAB ### AAB
To build a release aab file, run: To build a release aab file, run:
(`cd android && ./gradlew clean && ./gradlew :app:bundleRelease && cd ..`)
``` ```
yarn build-android-aab-release yarn build-android-aab-release
``` ```
It creates a new aab file named app-release.aab under ./android/app/build/outputs/bundle/release _which is a shortcut for:_ `cd android && ./gradlew clean && ./gradlew :app:bundleRelease && cd ..`
It creates a new aab file named `app-release.aab` under `./android/app/build/outputs/bundle/release`
For signing an aab you first need to configure the base module’s build.gradle file with your app’s signing information. You can then run this command: For signing an aab you first need to configure the base module’s build.gradle file with your app’s signing information. You can then run this command:
(`jarsigner -keystore ./android/app/drip-release-key.keystore ./android/app/build/outputs/bundle/release/app-release.aab drip-release-key`)
``` ```
yarn sign-android-aab-release yarn sign-android-aab-release
``` ```
_which is a shortcut for:_ `jarsigner -keystore ./android/app/drip-release-key.keystore ./android/app/build/outputs/bundle/release/app-release.aab drip-release-key`
## Share the release ## Share the release
### Gitlab repository ### Gitlab repository
For a quick and easy way to share an apk to testers who are willing to sideload drip onto their Android phones, do this: Upload a signed apk to the Gitlab repository of the drip website under `/release` https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/tree/main/release and maybe adapt the name of the apk with a more specific name than "app-release.apk". For a quick and easy way to share an apk to testers who are willing to sideload drip onto their Android phones, do this: Upload a signed apk to the Gitlab repository of the drip website under `/release` https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/tree/main/release and maybe adapt the name of the apk with a more specific name than "app-release.apk". Now you can simply share a direct link to download your newly bundled apk, e.g. [a download link for v1.2311.14](https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/blob/main/release/v1.2311.14.apk).
### Google Play Console ### Google Play Console
Upload a signed aab to the [Google Play Console for developers](https://play.google.com/console/) and add it to the App bundle explorer. This requires a higher versionCode and a different version name compared to previously uploaded aab or apk files. Upload a signed aab to the [Google Play Console for developers](https://play.google.com/console/) and add it to the "App bundle explorer". This requires a higher versionCode and a different version name compared to previously uploaded aab or apk files.
You can decide if you want the new app version to get released for testing (internal, closed or open) or for production. Keep in mind that any track other than "internal testing" trigger an external review by Google and might take a few hours. You can decide if you want the new app version to get released for testing (internal, closed or open) or for production. Keep in mind that any track other than "internal testing" triggers an external review by Google and might take a few hours.
#### Phone screenshots
If there are visual changes in the app you may want to update the screenshots for the Google Play Store listing. Keep in mind that Google Play has specific resolution requirements. You'll find them in Grow -> Store presence -> Main Store Listing -> Phone screenshots.
### drip website ### drip website
After a new version has been published on Google Play (or F-Droid) the apk version that is downloadable directly from the [drip website](https://dripapp.org) needs to get updated as well. Therefore you upload a signed apk to the [repository](https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/merge_requests/new) and adapt the name on /index.html. After a new version has been published on Google Play (or F-Droid) the apk version that is downloadable directly from the [drip website](https://dripapp.org) needs to get updated as well. Therefore you upload a signed apk to the [repository](https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/merge_requests/new) and adapt the name and link on /index.html.
Last time I checked it was [here](f3da9776b1943ffa32458e74ef86eeca98c1891c/index.html#L114). Last time I checked it was [here](f3da9776b1943ffa32458e74ef86eeca98c1891c/index.html#L114).
#### Phone screenshots
Please also update [phone screenshots here](https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/tree/main/assets) and set links on [/index](https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/blob/f3da9776b1943ffa32458e74ef86eeca98c1891c/index.html#L47) and [/media](https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/blob/c7f999bb7ad736345321537cbffa3f4c24eeee6d/media.html#L33) that can then also be attached to a social media post.
You probably want to share the app update by posting on one or more of these platforms:
- [Twitter](twitter.com/dripberlin)
- [Mastodon](mastodon.social/@dripapp)
- [Ko-fi](https://ko-fi.com/dripapp)
- [Linkedin](https://www.linkedin.com/company/34899684/)
- Different tech, privacy, feminist oriented slacks