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

Chore: Clean up TOC and add fdroid documentation

See merge request bloodyhealth/drip!679

CHANGELOG.md

@@ -2,6 +2,47 @@
 
 All notable changes to this project will be documented in this file.
 
+## v1.2403.19 Android & iOS
+
+### Changes
+
+- Disables temperature slider if temperature tracking off
+- Disables secondary symptom if fertility and or cervix/cervical mucus are off
+- Disables temperature reminder if temperature tracking off
+- Disabled period reminder if period predictions off
+- Return from sympto adapter if fertility off
+- Restructure settings menu
+- Unify wording to "sympto-thermal method"
+- Format decimal to x.0 instead of x.00 used for standard deviation and average cycle in stats
+- Use SelectTabGroup for secondary symptom customization
+
+- Android changes after updating React Native to 0.68.3
+- Update Android Gradle plugin from 7.0.3 to 7.0.4
+- Update NDK to "24.0.8215888" only for M1 users which added support for aarch64
+- Update metadata phone screenshots for Fdroid store listing
+- Updated dependencies:
+  - @react-native-community/datetimepicker from 6.3.1 to 7.2.0
+  - @react-native-async-storage/async-storage from ^1.17.9 to ^1.18.2
+  - metro-react-native-babel-preset from ^0.66.2 to ^0.67.0
+
+### Adds
+
+- Customization settings can turn on & off:
+
+  - Tracking categories
+  - Period predictions
+  - Fertility phases calculation
+
+- Home displays text elements depending on customization settings
+- Chart displays tracking category elements depending on customization settings
+- CycleDay displays tracking category elements and exclude switch depending on customization settings
+- Reminder can be disabled depending on customization settings
+- Adds disabled and more styling to AppSwitch
+- Adds TrackingCategorySwitch
+- Adds disabled, more styling and alert to SelectTabGroup
+- Adds more marginTop to License page
+- Adds info text to Password menu item in Settings
+
 ## v1.2401.17 iOS
 
 ### Changes

RELEASE.md

@@ -1,16 +1,44 @@
-# How to release a new app version for Android
+# How to release
 
-_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._
+drip is developed in React Native for iOS and Android and is released on 4 different platforms:
 
-# Table of Contents
+1. [Google Play Store](https://play.google.com/store/apps/details?id=com.drip)
+2. [Apple App Store](https://apps.apple.com/us/app/drip/id1584564949)
+3. [F-Droid](https://f-droid.org/packages/com.drip/)
+4. [drip Website](https://dripapp.org)
 
-1. [version updating](#Version-updating)
+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!
-2. [android building](#Building-in-Android)
-   - [APK](#APK)
-   - [AAB](#AAB)
-3. [release sharing](#Share-the-release)
 
-## Version updating
+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
+
+### 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)
+
+### 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.
 
@@ -34,7 +62,7 @@ Update the version number for iOS in `ios/drip/Info.plist` under:
 <string>1.2403.19</string>
 ```
 
-## Building in Android
+### Android builds
 
 APK versus AAB
 
@@ -42,7 +70,7 @@ APK versus AAB
 
 (https://developer.android.com/build/building-cmdline)
 
-### APK
+#### APK
 
 To build a release apk file, run the following command:
 
@@ -64,7 +92,7 @@ _which is a shortcut for:_ `zipalign -v -p 4 ./android/app/build/outputs/apk/rel
 
 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:
 
@@ -84,7 +112,7 @@ 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`
 
-## Building in iOS
+### iOS builds
 
 To build an .ipa archive file for an upload to the AppStore you need to go to xCode and select Build -> "Any iOS Device" and under "Product" -> "Archive".
 
@@ -95,29 +123,77 @@ 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
 
-## Share the release
+### User testing
 
-### Gitlab repository
+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).
 
+### 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**
+>
+>**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
+
+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.
+
+### Releases on Gitlab
+
+Under [Releases](https://gitlab.com/bloodyhealth/drip/-/releases) we keep track of all drip releases. 
+
+### 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).
+
+Please also update [phone screenshots for the website](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.
+
+## Publishing
+
 ### 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.
 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
+### Apple App Store Connect
 
-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.
+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/) and adapt the name and link 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/) 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).
-Last time I checked it was [here](f3da9776b1943ffa32458e74ef86eeca98c1891c/index.html#L114).
 
-#### Phone screenshots
+### Communication
-
-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:
 
@@ -126,3 +202,7 @@ You probably want to share the app update by posting on one or more of these pla
 - [Ko-fi](https://ko-fi.com/dripapp)
 - [Linkedin](https://www.linkedin.com/company/34899684/)
 - Different tech, privacy, feminist oriented slacks
+
+### Self care
+
+Congratulations. Take a break, eat some chocolate, go see a live show of your favorite band, masturbate <3!

lib/nfp-mucus.js

@@ -1,4 +1,4 @@
-export default function getSensiplanMucus(feeling, texture) {
+export default function getNfpMucus(feeling, texture) {
   if (typeof feeling != 'number' || typeof texture != 'number') return null
 
   const feelingMapping = {

package.json

@@ -12,8 +12,8 @@
   "scripts": {
     "start": "react-native start",
     "android": "react-native run-android",
-    "ios": "react-native run-ios --simulator=\"iPhone 15\"",
+    "ios": "react-native run-ios --simulator=\"iPhone 8 Plus\"",
-    "iosSE": "react-native run-ios --simulator=\"iPhone SE (2nd generation)\"",
+    "ios15": "react-native run-ios --simulator=\"iPhone 15 Plus\"",
     "log": "react-native log-android",
     "test": "jest test && yarn lint",
     "test-watch": "jest --watch test",

test/nfp-mucus.spec.js

@@ -0,0 +1,79 @@
+import getNfpMucus from '../lib/nfp-mucus'
+
+describe('getNfpMucus', () => {
+  test('returns null if there is no value for feeling or texture', () => {
+    expect(getNfpMucus()).toBeNull()
+    expect(getNfpMucus(undefined, 3)).toBeNull()
+    expect(getNfpMucus(2, undefined)).toBeNull()
+  })
+
+  describe('results in t for:', () => {
+    test('dry feeling and no texture', function () {
+      const nfpValue = getNfpMucus(0, 0)
+      expect(nfpValue).toEqual(0)
+    })
+  })
+
+  describe('results in Ø for:', () => {
+    test('no feeling and no texture', function () {
+      const nfpValue = getNfpMucus(1, 0)
+      expect(nfpValue).toEqual(1)
+    })
+  })
+
+  describe('results in f for:', () => {
+    test('wet feeling and no texture', function () {
+      const nfpValue = getNfpMucus(2, 0)
+      expect(nfpValue).toEqual(2)
+    })
+  })
+
+  describe('results in S for:', () => {
+    test('dry feeling and creamy texture', function () {
+      const nfpValue = getNfpMucus(0, 1)
+      expect(nfpValue).toEqual(3)
+    })
+
+    test('no feeling and creamy texture', function () {
+      const nfpValue = getNfpMucus(1, 1)
+      expect(nfpValue).toEqual(3)
+    })
+
+    test('wet feeling and creamy texture', function () {
+      const nfpValue = getNfpMucus(2, 1)
+      expect(nfpValue).toEqual(3)
+    })
+  })
+
+  describe('results in +S for:', () => {
+    test('dry feeling and egg white texture', function () {
+      const nfpValue = getNfpMucus(0, 2)
+      expect(nfpValue).toEqual(4)
+    })
+
+    test('no feeling and egg white texture', function () {
+      const nfpValue = getNfpMucus(1, 2)
+      expect(nfpValue).toEqual(4)
+    })
+
+    test('wet feeling and egg white texture', function () {
+      const nfpValue = getNfpMucus(2, 2)
+      expect(nfpValue).toEqual(4)
+    })
+
+    test('slippery feeling and egg white texture', function () {
+      const nfpValue = getNfpMucus(3, 2)
+      expect(nfpValue).toEqual(4)
+    })
+
+    test('slippery feeling and creamy texture', function () {
+      const nfpValue = getNfpMucus(3, 1)
+      expect(nfpValue).toEqual(4)
+    })
+
+    test('slippery feeling and no texture', function () {
+      const nfpValue = getNfpMucus(3, 0)
+      expect(nfpValue).toEqual(4)
+    })
+  })
+})

test/sensiplan-mucus.spec.js

@@ -1,79 +0,0 @@
-import getSensiplanMucus from '../lib/nfp-mucus'
-
-describe('getSensiplanMucus', () => {
-  test('returns null if there is no value for feeling or texture', () => {
-    expect(getSensiplanMucus()).toBeNull()
-    expect(getSensiplanMucus(undefined, 3)).toBeNull()
-    expect(getSensiplanMucus(2, undefined)).toBeNull()
-  })
-
-  describe('results in t for:', () => {
-    test('dry feeling and no texture', function () {
-      const sensiplanValue = getSensiplanMucus(0, 0)
-      expect(sensiplanValue).toEqual(0)
-    })
-  })
-
-  describe('results in Ø for:', () => {
-    test('no feeling and no texture', function () {
-      const sensiplanValue = getSensiplanMucus(1, 0)
-      expect(sensiplanValue).toEqual(1)
-    })
-  })
-
-  describe('results in f for:', () => {
-    test('wet feeling and no texture', function () {
-      const sensiplanValue = getSensiplanMucus(2, 0)
-      expect(sensiplanValue).toEqual(2)
-    })
-  })
-
-  describe('results in S for:', () => {
-    test('dry feeling and creamy texture', function () {
-      const sensiplanValue = getSensiplanMucus(0, 1)
-      expect(sensiplanValue).toEqual(3)
-    })
-
-    test('no feeling and creamy texture', function () {
-      const sensiplanValue = getSensiplanMucus(1, 1)
-      expect(sensiplanValue).toEqual(3)
-    })
-
-    test('wet feeling and creamy texture', function () {
-      const sensiplanValue = getSensiplanMucus(2, 1)
-      expect(sensiplanValue).toEqual(3)
-    })
-  })
-
-  describe('results in +S for:', () => {
-    test('dry feeling and egg white texture', function () {
-      const sensiplanValue = getSensiplanMucus(0, 2)
-      expect(sensiplanValue).toEqual(4)
-    })
-
-    test('no feeling and egg white texture', function () {
-      const sensiplanValue = getSensiplanMucus(1, 2)
-      expect(sensiplanValue).toEqual(4)
-    })
-
-    test('wet feeling and egg white texture', function () {
-      const sensiplanValue = getSensiplanMucus(2, 2)
-      expect(sensiplanValue).toEqual(4)
-    })
-
-    test('slippery feeling and egg white texture', function () {
-      const sensiplanValue = getSensiplanMucus(3, 2)
-      expect(sensiplanValue).toEqual(4)
-    })
-
-    test('slippery feeling and creamy texture', function () {
-      const sensiplanValue = getSensiplanMucus(3, 1)
-      expect(sensiplanValue).toEqual(4)
-    })
-
-    test('slippery feeling and no texture', function () {
-      const sensiplanValue = getSensiplanMucus(3, 0)
-      expect(sensiplanValue).toEqual(4)
-    })
-  })
-})