chore: remove overall release plan document and add mobile app release process documentation
This commit is contained in:
Achintha Isuru
@@ -92,7 +92,7 @@ You have access to `prototypes/` folders. When migrating code:
|
||||
|
||||
1. **Extract Assets**:
|
||||
* You MAY copy icons, images, and colors. But they should be tailored to the current design system. Do not change the colours and typgorahys in the design system. They are final. And you have to use these in the UI.
|
||||
* When you matching colous and typography, from the POC match it with the design system and use the colors and typography from the design system. As mentioned in the `apps/mobile/docs/03-design-system-usage.md`.
|
||||
* When you matching colous and typography, from the POC match it with the design system and use the colors and typography from the design system. As mentioned in the `apps/mobile/docs/02-design-system-usage.md`.
|
||||
2. **Extract Layouts**: You MAY copy `build` methods for UI structure.
|
||||
3. **REJECT Architecture**: You MUST **NOT** copy the `GetX`, `Provider`, or `MVC` patterns often found in prototypes. Refactor immediately to **Bloc + Clean Architecture with Flutter Modular and Melos**.
|
||||
|
||||
@@ -103,7 +103,7 @@ If a user request is vague:
|
||||
1. **STOP**: Do not guess domain fields or workflows.
|
||||
2. **ANALYZE**:
|
||||
- For architecture related questions, refer to `apps/mobile/docs/01-architecture-principles.md` or existing code.
|
||||
- For design system related questions, refer to `apps/mobile/docs/03-design-system-usage.md` or existing code.
|
||||
- For design system related questions, refer to `apps/mobile/docs/02-design-system-usage.md` or existing code.
|
||||
3. **DOCUMENT**: If you must make an assumption to proceed, add a comment `// ASSUMPTION: <explanation>` and mention it in your final summary.
|
||||
4. **ASK**: Prefer asking the user for clarification on business rules (e.g., "Should a 'Job' have a 'status'?").
|
||||
|
||||
|
||||
@@ -105,11 +105,11 @@ graph TD
|
||||
- If not possible, and if that specific widget is used in multiple features, then try to create a shared widget in the `apps/mobile/packages/design_system/widgets`.
|
||||
- Theme definitions (Colors, Typography).
|
||||
- Assets (Icons, Images).
|
||||
- More details on how to use this package is available in the `apps/mobile/docs/03-design-system-usage.md`.
|
||||
- More details on how to use this package is available in the `apps/mobile/docs/02-design-system-usage.md`.
|
||||
- **RESTRICTION**:
|
||||
- CANNOT change colours or typography.
|
||||
- Dumb widgets only. NO business logic. NO state management (Bloc).
|
||||
- More details on how to use this package is available in the `apps/mobile/docs/03-design-system-usage.md`.
|
||||
- More details on how to use this package is available in the `apps/mobile/docs/02-design-system-usage.md`.
|
||||
|
||||
### 2.6 Core Localization (`apps/mobile/packages/core_localization`)
|
||||
- **Role**: Centralized language and localization management.
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
# 📊 Use Case Completion Audit
|
||||
|
||||
**Generated:** 2026-03-02
|
||||
**Generated:** 2026-03-06
|
||||
**Auditor Role:** System Analyst / Flutter Architect
|
||||
**Source of Truth:** `docs/ARCHITECTURE/client-mobile-application/use-case.md`, `docs/ARCHITECTURE/staff-mobile-application/use-case.md`
|
||||
**Codebase Checked:** `apps/mobile/packages/features/` and `apps/mobile/apps/` (actual production apps)
|
||||
**Codebase Checked:** `apps/mobile/packages/features/` and `apps/mobile/apps/` (actual production apps)
|
||||
**Latest Milestone:** M4 (released 2026-03-05)
|
||||
|
||||
---
|
||||
|
||||
@@ -162,7 +163,7 @@
|
||||
| 2.1 Browse & Filter Jobs | Filter by Distance | ✅ | ✅ Completed | Distance/radius filtering implemented in shifts module. |
|
||||
| 2.1 Browse & Filter Jobs | View job card details | ✅ | ✅ Completed | Comprehensive job cards with pay, location, requirements. |
|
||||
| 2.3 Set Availability | Select dates/times → Save preferences | ✅ | ✅ Completed | `availability_page.dart` + AvailabilityBloc with 3 use cases. |
|
||||
| View Benefits | Browse available benefits | ✅ | 🚫 Completed | `benefits_overview_page.dart` (454 lines) fully implemented as part of home module. |
|
||||
| View Benefits | Browse available benefits | ✅ | ✅ Completed | `benefits_overview_page.dart` in home module. Documented in M4 milestone. |
|
||||
| Upcoming Shift Quick-Link | Next shift banner on home | ✅ | 🚫 Completed | Upcoming shifts display on worker home page. |
|
||||
|
||||
---
|
||||
@@ -215,18 +216,18 @@
|
||||
| Use Case | Sub-Use Case | Production App | Status | Notes |
|
||||
|:---|:---|:---:|:---:|:---|
|
||||
| 5.1 Manage Compliance Documents | Navigate to Compliance Menu | ✅ | ✅ Completed | Compliance section in `staff_profile_page.dart`. |
|
||||
| 5.1 Manage Compliance Documents | Upload Certificates | ✅ | ✅ Completed | `certificates/` module with 4 use cases + 2 pages. |
|
||||
| 5.1 Manage Compliance Documents | View/Manage Identity Documents | ✅ | ✅ Completed | `documents/` module with upload + view functionality. |
|
||||
| 5.2 Manage Tax Forms | Complete W-4 digitally & submit | ✅ | ✅ Completed | `tax_forms/form_w4_page.dart` + FormW4Cubit + use cases. |
|
||||
| 5.2 Manage Tax Forms | Complete I-9 digitally & submit | ✅ | ✅ Completed | `tax_forms/form_i9_page.dart` + FormI9Cubit + use cases. |
|
||||
| 5.4 Account Settings | Update Bank Details | ✅ | ✅ Completed | `staff_bank_account/` module with page + cubit. |
|
||||
| 5.4 Account Settings | Access Support / FAQs | ✅ | ✅ Completed | `faqs/` module with search functionality + 2 use cases. |
|
||||
| Personal Info Management | Update profile information | ✅ | 🚫 Completed | `profile_info/` module with 3 pages (personal info, language, locations). |
|
||||
| Emergency Contact | Manage emergency contacts | ✅ | 🚫 Completed | `emergency_contact/` module with get + save use cases. |
|
||||
| Experience Management | Update industries and skills | ✅ | 🚫 Completed | `experience/` module with 3 use cases. |
|
||||
| Attire Management | Upload attire photos | ✅ | 🚫 Completed | `attire/` module with upload + photo management. |
|
||||
| Timecard Viewing | View clock-in/out history | ✅ | 🚫 Completed | `time_card/` module with get_time_cards use case. |
|
||||
| Privacy & Security | Manage privacy settings | ✅ | 🚫 Completed | `privacy_security/` module with 4 use cases + 2 pages. |
|
||||
| 5.1 Manage Compliance Documents | Upload Certificates | ✅ | ✅ Completed | `profile_sections/compliance/certificates/` module with 4 use cases + 2 pages. M4 feature. |
|
||||
| 5.1 Manage Compliance Documents | View/Manage Identity Documents | ✅ | ✅ Completed | `profile_sections/compliance/documents/` module with camera/gallery upload. M4 feature. |
|
||||
| 5.2 Manage Tax Forms | Complete W-4 digitally & submit | ✅ | ✅ Completed | `profile_sections/finances/tax_forms/form_w4_page.dart` + FormW4Cubit + use cases. |
|
||||
| 5.2 Manage Tax Forms | Complete I-9 digitally & submit | ✅ | ✅ Completed | `profile_sections/finances/tax_forms/form_i9_page.dart` + FormI9Cubit + use cases. |
|
||||
| 5.4 Account Settings | Update Bank Details | ✅ | ✅ Completed | `profile_sections/finances/staff_bank_account/` module with page + cubit. |
|
||||
| 5.4 Account Settings | Access Support / FAQs | ✅ | ✅ Completed | `profile_sections/support/faqs/` module with search functionality + 2 use cases. |
|
||||
| Personal Info Management | Update profile information | ✅ | ✅ Completed | `profile_sections/onboarding/profile_info/` module with 3 pages. Documented in M4. |
|
||||
| Emergency Contact | Manage emergency contacts | ✅ | ✅ Completed | `profile_sections/onboarding/emergency_contact/` module. Documented in M4. |
|
||||
| Experience Management | Update industries and skills | ✅ | ✅ Completed | `profile_sections/onboarding/experience/` module with 3 use cases. Documented in M4. |
|
||||
| Attire Management | Upload attire photos & verification | ✅ | ✅ Completed | `profile_sections/compliance/attire/` module with camera/gallery support. Documented in M4. |
|
||||
| Timecard Viewing | View clock-in/out history | ✅ | 🚫 Completed | `profile_sections/finances/time_card/` module with get_time_cards use case. |
|
||||
| Privacy & Security | Manage privacy settings & visibility | ✅ | ✅ Completed | `profile_sections/support/privacy_security/` module with 4 use cases + 2 pages. Documented in M4. |
|
||||
|
||||
---
|
||||
|
||||
@@ -235,7 +236,6 @@
|
||||
| Feature | Status | Notes |
|
||||
|:---|:---:|:---|
|
||||
| 5.3 KROW University Training | ❌ Missing | No training module exists. Module, video/quiz functionality not implemented. |
|
||||
| 5.4 View Benefits | ✅ **Actually Implemented** | Found in home module as `benefits_overview_page.dart` (454 lines). |
|
||||
| In-App Support Chat | ❌ Missing | No messaging module (only push notification support). |
|
||||
| Leaderboard | ❌ Missing | No competitive tracking/gamification module. |
|
||||
|
||||
@@ -269,7 +269,7 @@
|
||||
- ✅ Clock In/Out (GPS + NFC): 100%
|
||||
- ✅ Payments & Early Pay: 100%
|
||||
- ✅ Availability: 100%
|
||||
- ✅ Profile & Compliance: 100% (11 subsections)
|
||||
- ✅ Profile & Compliance: 100% (13 subsections via modular `profile_sections` structure)
|
||||
- ❌ KROW University: 0% (training module not implemented)
|
||||
|
||||
---
|
||||
@@ -292,7 +292,12 @@
|
||||
- **Presentation** (pages, widgets, BLoCs)
|
||||
- **Domain** (use cases, entities)
|
||||
- **Data** (repositories, models, data sources)
|
||||
- **Dependency injection** via GetIt
|
||||
- **Dependency injection** via Flutter Modular
|
||||
- **Modular Profile Sections** (M4): Staff profile features organized in `profile_sections/` with 4 sub-modules:
|
||||
- `onboarding/` - Profile info, experience, emergency contacts
|
||||
- `compliance/` - Documents, certificates, attire
|
||||
- `finances/` - Bank account, tax forms, timecard
|
||||
- `support/` - FAQs, privacy & security
|
||||
|
||||
### Known Technical Debt
|
||||
- **Coverage Re-post**: Mutation exists but noted as stub in code (needs backend wiring)
|
||||
|
||||
64
docs/MOBILE/05-release-process.md
Normal file
64
docs/MOBILE/05-release-process.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Mobile Release Process
|
||||
|
||||
**For complete release documentation, see: [docs/RELEASE/mobile-releases.md](../RELEASE/mobile-releases.md)**
|
||||
|
||||
---
|
||||
|
||||
## Quick Links
|
||||
|
||||
### Release Workflows
|
||||
- **Product Release**: Trigger at: [GitHub Actions](https://github.com/Oloodi/krow-workforce/actions/workflows/product-release.yml)
|
||||
- **Hotfix Creation**: Trigger at: [GitHub Actions](https://github.com/Oloodi/krow-workforce/actions/workflows/hotfix-branch-creation.yml)
|
||||
|
||||
### Key Concepts
|
||||
|
||||
**Versioning**: We use semantic versioning with milestone suffixes (e.g., `0.0.1-m4`)
|
||||
- Defined in: `apps/mobile/apps/staff/pubspec.yaml` or `apps/mobile/apps/client/pubspec.yaml`
|
||||
- Auto-extracted by workflows (no manual input required)
|
||||
|
||||
**CHANGELOGs**:
|
||||
- Staff: `apps/mobile/apps/staff/CHANGELOG.md`
|
||||
- Client: `apps/mobile/apps/client/CHANGELOG.md`
|
||||
- Format: `## [v0.0.1-m4] - Milestone 4 - 2026-03-05`
|
||||
|
||||
**Git Tags**: `krow-withus-<app>-mobile/<env>-vX.Y.Z`
|
||||
- Example: `krow-withus-worker-mobile/dev-v0.0.1-m4`
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Standard Release
|
||||
|
||||
1. **Update CHANGELOG** with user-facing changes
|
||||
2. **Update version** in `pubspec.yaml`
|
||||
3. **Commit and push** to dev branch
|
||||
4. **Trigger workflow**:
|
||||
- Go to GitHub Actions → "📦 Product Release"
|
||||
- Select app (worker/client) and environment (dev/stage/prod)
|
||||
- Click "Run workflow"
|
||||
|
||||
### Hotfix Release
|
||||
|
||||
1. **Trigger workflow**:
|
||||
- Go to GitHub Actions → "🚨 Product Hotfix - Create Branch"
|
||||
- Enter current production version and issue description
|
||||
- Workflow creates branch and updates version/CHANGELOG
|
||||
2. **Fix bug** on hotfix branch
|
||||
3. **Merge to main** and release to production
|
||||
|
||||
---
|
||||
|
||||
## For Complete Details
|
||||
|
||||
See the comprehensive documentation: **[docs/RELEASE/mobile-releases.md](../RELEASE/mobile-releases.md)**
|
||||
|
||||
This includes:
|
||||
- ✅ Detailed versioning strategy
|
||||
- ✅ CHANGELOG format guidelines
|
||||
- ✅ Step-by-step release procedures
|
||||
- ✅ APK signing setup (24 GitHub Secrets)
|
||||
- ✅ Helper scripts reference
|
||||
- ✅ Hotfix process
|
||||
- ✅ Troubleshooting guide
|
||||
- ✅ Release cadence (dev/stage/prod)
|
||||
Reference in New Issue
Block a user