Merge branch 'ml-opensource:master' into chore/update-dependencies

.github/workflows/pull_request_validation.yml

@@ -1,19 +1,42 @@
-# This workflow builds, analyses and tests every pull request.
+# This workflow builds, analyzes, and tests every pull request.
 name: Pull Request Validation
-on: pull_request
+on:
+  push:
+    branches:
+      - develop
+      - main
+      - master
+
+  pull_request:
+
 jobs:
   analyze-and-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-java@v1
+      - name: 📚 Git Checkout
+        uses: actions/checkout@v4
+
+      - name: 🐦 Setup Flutter
+        uses: subosito/flutter-action@v2
         with:
-          java-version: "12.x"
-      - uses: subosito/flutter-action@v1
-        with:
-          channel: "stable"
-      - run: flutter pub get
-      - run: flutter pub run build_runner build --delete-conflicting-outputs
-      - run: flutter build apk --release --flavor production -t lib/main_production.dart
-      - run: flutter analyze
-      - run: flutter test
+          channel: 'stable'
+          cache: true
+          cache-key: flutter-:os:-:channel:-:version:-:arch:-:hash:-${{ hashFiles('**/pubspec.lock') }}
+
+      - name: 📦 Install Dependencies
+        run: flutter pub get
+
+      - name: 🛠️ Build Runner (Generate Code)
+        run: flutter pub run build_runner build --delete-conflicting-outputs
+
+      - name: 🕵️ Analyze Code
+        run: flutter analyze lib test
+
+      - name: ✨ Check Formatting
+        run: dart format --line-length 80 --set-exit-if-changed lib test
+
+      - name: 🏗️ Build APK (Production Flavor)
+        run: flutter build apk --release --flavor production -t lib/main_production.dart
+
+      - name: 🧪 Run Tests
+        run: flutter test

README.md

@@ -1,20 +1,31 @@
 # App name - Flutter
 
 ## 📖 Project description
+
 This project serves as a template project for Flutter applications. You can generate a new repository by clicking "Use this template" above.
 
 ## 🔧 Setup and Installation
+
 - Execute `$ flutter doctor` to verify installations
 - Execute `$ pub get` to pull project dependencies
 - Execute a run configuration of choice
-  - `$ flutter run --flavor staging -t lib/main_staging.dart`
-  - `$ flutter run --flavor production -t lib/main_production.dart`
+  - `$ flutter run --flavor development -t lib/main_development.dart --dart-define-from-file=lib/config/dart_define_keys/dart_define_development_keys.json`
+  - `$ flutter run --flavor staging -t lib/main_staging.dart --dart-define-from-file=lib/config/dart_define_keys/dart_define_staging_keys.json`
+
+⚠️ **Running the Production Flavor**
+
+It is **not recommended** to run the production flavor directly from the IDE
+(VS Code or Android Studio) as it may be run by mistake. For ease and accuracy,
+it is advised to run flavors via the **VS Code launch menu** or the **Android
+Studio Run menu** instead.
 
 ## 🌲 Branches
-* `master` - Latest version in the app store.
-* `develop` - Default. Feature branches are merged in when complete and then deleted.
+
+- `master` - Latest version in the app store.
+- `develop` - Default. Feature branches are merged in when complete and then deleted.
 
 ## 🔗 Useful links
+
 - [Jira Board](https://TODO)
 - [Confluence](https://TODO)
 - [Slack Channel](https://TODO)