Document release workflow

docs/development-setup.md

@@ -20,6 +20,14 @@ This short guide focuses on setting up the project using IntelliJ instead of And
 5. Run `flutter pub get` in `frontend/`
 6. Execute the "Run Flutter" (upper right corner of IDE) configuration from within IntelliJ
 
+As there are several services running and interacting some ports need to be forwarded.
+This includes the backend port 8000 and the map tiles port at 5002.
+For this run:
+```
+adb reverse tcp:5002 tcp:5002
+adb reverse tcp:8000 tcp:8000
+```
+
 # Backend
 
 1. Install docker and docker-compose

docs/production-setup.md

@@ -1,4 +1,66 @@
 # Setup of production
 
-The deployment to production is done by the [Digitalfabrik](https://github.com/digitalfabrik/) and is not public.
-Reach out to [@maxammann](https://github.com/maxammann/) for more information and insights.
+> The deployment to production is done by the [Digitalfabrik](https://github.com/digitalfabrik/) and is not public.
+> Reach out to [@maxammann](https://github.com/maxammann/) or [@sarahsporck](https://github.com/sarahsporck/) for more information and insights.
+
+## Certificates and Signing
+
+### Android
+
+Clone the [app-credentials](https://github.com/digitalfabrik/app-credentials) repo.
+
+In `frontend/android` create a file `local.properties` (if it does not already exist).
+
+Add the following entries for signing:
+
+```bash
+signing.keyAlias=upload
+signing.keyPassword=<passbolt - Ehrenamtskarte Bayern Keystore Key Password>
+signing.storeFile=<path-to-local-repo>/app-credentials/android/nuernberg-sozialpass.jks
+signing.storePassword=<passbolt - Ehrenamtskarte Bayern Keystore Password>
+```
+
+### iOS
+
+In `frontend/iOS`  run `bundle exec fastlane match appstore` .
+
+- Use user [app-team@integreat-app.de](mailto:app-team@integreat-app.de) and password from `<passbolt - Digitalfabrik Fastlane Match>`
+- Set correct app_identifier (a list of identifier is also allowed): `app.sozialpass.nuernberg,de.nrw.it.ehrensachebayern`
+
+## Release Workflow
+
+For Nürnberg replace:
+
+- bayern → nuernberg
+- Bayern → Nuernberg
+
+1. Increase version in `frontend/pubspec.yaml` (check out the version in the google play console or in app store connect)
+2. In a shell navigate to the `frontend` directory
+3. Select the correct build version
+
+```bash
+fvm flutter pub run build_runner build —define “df_build_config=name=bayern”
+```
+
+4. Create bundles
+
+```bash
+# Android
+fvm flutter build appbundle --flavor Bayern --release --dart-define=environment=production
+
+# iOS
+# Make sure the correct certificate is selected for the release job in xcode
+fvm flutter build ipa --flavor Bayern --release --dart-define=environment=production
+# This will show an error "exportArchive: "Runner.app" requires a provisioning profile."
+# but an xcarchive will still be created which then can be distributed via xcode
+```
+
+5. Release:
+    1. In the Google Play Console create a new release for Open Testing. For this upload the app bundle from `build/app/outputs/bundle/bayernRelease/app-bayern-release.aab`. Once the release is approved by Google Play promote to production.
+    2. `open ./build/ios/archive/Runner.xcarchive` → navigate the dialog and finally distribute the app. This will create a release on Testflight. Once apple has approved the Testflight release, the app can be “promoted”. For that change the build and version number in app store connect and let the app be checked a second time. Finally the app can be released.
+
+## Snapshots
+
+The Snapshots are created by executing a bunch of e2e tests locally. Check out `frontend/ios/ScreenshotTest` .
+
+iOS snapshots can be created via `bundle exec fastlane snapshot` in the `frontend/ios` directory. For that you’ll have to install a bunch of simulators in XCode (see `frontend/ios/fastlane/Snapfile`)