Merge branch 'Chore/Finetune-release-documentation' into 'main'

Chore: Clean up TOC and add fdroid documentation

See merge request bloodyhealth/drip!679

RELEASE.md

@@ -7,27 +7,38 @@ drip is developed in React Native for iOS and Android and is released on 4 diffe
 3. [F-Droid](https://f-droid.org/packages/com.drip/)
 4. [drip Website](https://dripapp.org)
 
-In an ideal world the app version is the same across platforms. In reality this has never been the case.
+In an ideal world the app version is the same across platforms. In the past this has never been the case. The release v1.2403.19 is the first to be up to date on all 4 platforms!
 
 Releasing a new version is very exciting and brings happy changes like fixing a bug, improving a feature, updating dependencies or adding a new functionality to the app. It is more than just pressing the button "publish new version".
 
 _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.
 
-### Release steps
+## Release steps
 
-1. [Version updating](#version-updating)
-2. [Android builds](#android-builds)
-3. [iOS builds](#ios-builds)
-4. [User testing](#user-testing)
-5. [Changelog](#changelog)
-6. [Release notes](#release-notes)
-7. [Release tag](#release-tag)
-8. [Phone screenshots](#phone-screenshots)
-9. [Publishing](#publishing)
-10. [Communication](#communication)
-11. [Self care](#self-care)
+### 1. [Code](#code)
+- 1.1 [Version updating](#version-updating)
+- 1.2 [Android builds](#android-builds)
+- 1.3 [iOS builds](#ios-builds)
+- 1.4 [User testing](#user-testing)
+- 1.5 [Release tag](#release-tag)
 
-## Version updating
+### 2. [Documentation](#documentation)
+- 2.1 [Changelog](#changelog)
+- 2.2 [Release notes](#release-notes)
+- 2.3 [Releases on Gitlab](#releases-on-gitlab)
+- 2.4 [Phone screenshots](#phone-screenshots)
+
+### 3. [Publishing](#publishing)
+- 3.1 [Google Play Console](#google-play-console)
+- 3.2 [Apple App Store Connect](#apple-app-store-connect)
+- 3.3 [F-droid](#f-droid)
+- 3.4 [drip website](#drip-website)
+- 3.5 [Communication](#communication)
+- 3.6 [Self care](#self-care)
+
+## Code
+
+### Version updating
 
 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.7`. If you want to upload a new app version to Google Play you also need to update the version code.
 
@@ -112,42 +123,50 @@ Once the archiving process has completed you can chose to do the following:
 - TestFlight & App Store for when you want to upload it for external testing and/or production release
 - TestFlight Internal Only for when you want to upload it for internal testing
 
-## User testing
+### User testing
 
 To enable external testing you need to remember that Google Play and Apple App Store might take up to 1 day for their review process. "External testing" for iOS allows testing drip on Testflight anonymously via a public link. "Open testing" for Android allows testing drip on Google Play as beta tester below the normal production listing.
 
 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).
 
-## Changelog
+### Release tag
+
+[Tags](https://gitlab.com/bloodyhealth/drip/-/tags) can mark a specific point in the coding/commmit history and helps us identify the version status of a released app. They are named "iOS-v1.2401.17" or "Release-v1.yymm.d".
+
+Any tag starting with "Release" or "Android" will be checked by https://gitlab.com/fdroidci
+
+## Documentation
+
+### Changelog
 
 The [changelog](https://gitlab.com/bloodyhealth/drip/-/blob/main/CHANGELOG.md) should reflect the technical / code changes between a previous and the new version. Please update the changelog file with any relevant additions, fixes and changes in the following format:
 
-**v1.yymm.d**
+>**v1.yymm.d**
+>
+>**Changes**
+>
+>Changing the color of funky button
+>Updating a library from 1.2.3 to 2.3.4
+>
+>**Adds**
+>
+>New feature for calendar
+>
+>**Fixed**
+>
+>Small bug in chart
 
-**Changes**
-
-Changing the color of funky button
-Updating a library from 1.2.3 to 2.3.4
-
-**Adds**
-
-New feature for calendar
-
-**Fixed**
-
-Small bug in chart
-
-## Release notes
+### Release notes
 
 These notes are for the users and curious ones who may want to start using drip. They should be based on the changelog but written in a friendly and easy to understand way. The focus is on the user perspective and the impact of the changes for the user. Behind the scenes and in depth code changes are less relevant.
 
 Google Play limits these notes to 500 characters, whereas Apple's App Store limits these notes to 4.000 characters. In Fdroid there are no release notes.
 
-## Release tag
+### Releases on Gitlab
 
-[Tags](https://gitlab.com/bloodyhealth/drip/-/tags) can mark a specific point in the coding/commmit history and helps us identify the version status of a released app. They are named "iOS-v1.2401.17" or "Release-v1.yymm.d".
+Under [Releases](https://gitlab.com/bloodyhealth/drip/-/releases) we keep track of all drip releases. 
 
-## Phone screenshots
+### Phone screenshots
 
 If there are visual changes in the app you may want to update the screenshots for the Google Play Store listing, which allows up to 8 and for Apple's App Store, which allows up to 10 screenshots. Keep in mind that both Google Play and Apple have specific resolution requirements. You'll find Google's in Grow -> Store presence -> Main Store Listing -> Phone screenshots and Apple's on the main App Store Connect site. Here is a link for [Apple's screenshot specifications](https://developer.apple.com/help/app-store-connect/reference/screenshot-specifications).
 
@@ -164,11 +183,17 @@ You can decide if you want the new app version to get released for testing (inte
 
 Upload a new version and submit it for review, before it can be published.
 
+### F-droid
+
+This account runs automated checks for drip looking at new `Release` or `Android` [tags](https://gitlab.com/bloodyhealth/drip/-/tags/) and updates the app's metadata yaml file in Fdroid without further ado.
+
+However this is not the full story. Please have a look at previous commits to see what necessary changes got pushed, [see here](https://gitlab.com/fdroid/fdroiddata/-/commits/master/metadata/com.drip.yml).
+
 ### 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/) as [we did in this commit](https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/commit/f8c0f90c1ae9f23bf8e1bc311790b85443149a4d), and adapt the name and link on /index.html [as we did in this commit](https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/commit2f8850ff5fa78615a4f335b625ea4a67d4acf03a) and [this commit](https://gitlab.com/bloodyhealth/bloodyhealth.gitlab.io/-/commit/f3da9776b1943ffa32458e74ef86eeca98c1891c). Last time I checked it was [here](f3da9776b1943ffa32458e74ef86eeca98c1891c/index.html#L114).
 
-## Communication
+### Communication
 
 You probably want to share the app update by posting on one or more of these platforms:
 
@@ -178,6 +203,6 @@ You probably want to share the app update by posting on one or more of these pla
 - [Linkedin](https://www.linkedin.com/company/34899684/)
 - Different tech, privacy, feminist oriented slacks
 
-## Self care
+### Self care
 
 Congratulations. Take a break, eat some chocolate, go see a live show of your favorite band, masturbate <3!