feat: add comprehensive release process documentation and version file references
- Introduced RELEASE_VISUAL_GUIDE.md for a visual overview of the release pipeline, including development, staging, and production phases. - Created RELEASE_WORKFLOW.md detailing step-by-step release procedures for single and multi-product releases, including hotfix processes. - Added VERSION_FILES_REFERENCE.md to outline all necessary version file updates for each product during releases, ensuring consistency and completeness.
This commit is contained in:
Achintha Isuru
343
docs/RELEASE/HOTFIX_PROCESS.md
Normal file
343
docs/RELEASE/HOTFIX_PROCESS.md
Normal file
@@ -0,0 +1,343 @@
|
||||
# Hotfix Process
|
||||
|
||||
**For Emergency Production Fixes**
|
||||
|
||||
---
|
||||
|
||||
## 🚨 When to Hotfix
|
||||
|
||||
Use hotfix when:
|
||||
- ✅ Critical bug in production affecting users
|
||||
- ✅ Data loss or security vulnerability
|
||||
- ✅ Service unavailable or major feature broken
|
||||
- ✅ Customer-blocking issue
|
||||
|
||||
**Don't use hotfix for:**
|
||||
- ❌ Minor bugs (can wait for next release)
|
||||
- ❌ Feature requests
|
||||
- ❌ Nice-to-have improvements
|
||||
- ❌ Styling issues
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Hotfix Process
|
||||
|
||||
### Step 1: Assess & Declare Emergency
|
||||
|
||||
```
|
||||
Issue: [Brief description]
|
||||
Severity: CRITICAL / HIGH / MEDIUM
|
||||
Product: [Staff Mobile / Client Mobile / Web / Backend]
|
||||
Environment: Production
|
||||
Impact: [How many users affected]
|
||||
```
|
||||
|
||||
Once severity confirmed → Start hotfix immediately.
|
||||
|
||||
---
|
||||
|
||||
### Step 2: Create Hotfix Branch
|
||||
|
||||
```bash
|
||||
# From production tag
|
||||
git checkout -b hotfix/krow-withus-worker-mobile-v0.1.1 \
|
||||
krow-withus-worker-mobile/prod-v0.1.0
|
||||
|
||||
# Verify you're on the right tag
|
||||
git log -1 --oneline
|
||||
```
|
||||
|
||||
**Format**: `hotfix/<product>-v<PATCH+1>`
|
||||
|
||||
---
|
||||
|
||||
### Step 3: Fix the Bug
|
||||
|
||||
```bash
|
||||
# Make your fix
|
||||
# Edit files, test locally
|
||||
|
||||
# Commit with clear message
|
||||
git commit -m "fix: [issue description]
|
||||
|
||||
HOTFIX for production
|
||||
Issue: [what happened]
|
||||
Solution: [what was fixed]
|
||||
Tested: [how was it tested locally]"
|
||||
```
|
||||
|
||||
**Keep it minimal:**
|
||||
- Only fix the specific bug
|
||||
- Don't refactor or optimize
|
||||
- Don't add new features
|
||||
|
||||
---
|
||||
|
||||
### Step 4: Update Version
|
||||
|
||||
Update PATCH version only (0.1.0 → 0.1.1):
|
||||
|
||||
**For Mobile** (`apps/mobile/apps/*/pubspec.yaml`):
|
||||
```yaml
|
||||
# Old
|
||||
version: 0.1.0+5
|
||||
|
||||
# New
|
||||
version: 0.1.1+6 # Only PATCH changed
|
||||
```
|
||||
|
||||
**For Web** (`apps/web/package.json`):
|
||||
```json
|
||||
"version": "0.1.1"
|
||||
```
|
||||
|
||||
**For Backend** (`backend/*/package.json`):
|
||||
```json
|
||||
"version": "0.1.1"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 5: Update CHANGELOG
|
||||
|
||||
Add entry to **top** of appropriate CHANGELOG:
|
||||
|
||||
```markdown
|
||||
| 2026-03-05 | 0.1.1 | HOTFIX: [Issue fixed] |
|
||||
|
||||
(previous entries below...)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 6: Code Review (Expedited)
|
||||
|
||||
```bash
|
||||
# Push hotfix branch
|
||||
git push origin hotfix/krow-withus-worker-mobile-v0.1.1
|
||||
|
||||
# Create PR on GitHub with URGENT label
|
||||
gh pr create --title "HOTFIX: [Issue description]" \
|
||||
--body "**URGENT PRODUCTION FIX**
|
||||
|
||||
Issue: [What was broken]
|
||||
Impact: [Users affected]
|
||||
Solution: [What was fixed]
|
||||
Testing: [Local verification]"
|
||||
```
|
||||
|
||||
**Get approval within 15 minutes if possible.**
|
||||
|
||||
---
|
||||
|
||||
### Step 7: Merge to Main
|
||||
|
||||
```bash
|
||||
# Review complete - merge
|
||||
git checkout main
|
||||
git pull origin main
|
||||
git merge --ff-only hotfix/krow-withus-worker-mobile-v0.1.1
|
||||
git push origin main
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 8: Create Production Tag
|
||||
|
||||
```bash
|
||||
# Create tag from main
|
||||
git tag -a krow-withus-worker-mobile/prod-v0.1.1 \
|
||||
-m "HOTFIX: [Issue fixed]"
|
||||
|
||||
git push origin krow-withus-worker-mobile/prod-v0.1.1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 9: Deploy to Production
|
||||
|
||||
```bash
|
||||
# Follow your deployment procedure
|
||||
# Higher priority than normal releases
|
||||
|
||||
./scripts/deploy-mobile-production.sh krow-withus-worker-mobile/prod-v0.1.1
|
||||
```
|
||||
|
||||
**Deployment time**: Within 30 minutes of approval
|
||||
|
||||
---
|
||||
|
||||
### Step 10: Verify & Monitor
|
||||
|
||||
```bash
|
||||
# Smoke tests
|
||||
- App launches
|
||||
- Core features work
|
||||
- No new errors
|
||||
|
||||
# Monitor for 2 hours
|
||||
- Watch error logs
|
||||
- Check user reports
|
||||
- Verify fix worked
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 11: Communicate
|
||||
|
||||
**Immediately after deployment:**
|
||||
|
||||
```markdown
|
||||
🚨 PRODUCTION HOTFIX DEPLOYED
|
||||
|
||||
Product: Worker Mobile
|
||||
Version: 0.1.1
|
||||
Issue: [Fixed issue]
|
||||
Impact: [Resolved for X users]
|
||||
Status: ✅ Deployed & verified
|
||||
|
||||
No user action required.
|
||||
Service restored to normal.
|
||||
```
|
||||
|
||||
**24 hours later:**
|
||||
|
||||
```markdown
|
||||
✅ HOTFIX STATUS UPDATE
|
||||
|
||||
Production hotfix v0.1.1 deployed 24 hours ago.
|
||||
Zero errors reported post-deployment.
|
||||
System stable.
|
||||
|
||||
Thank you for your patience!
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⏱️ Timeline
|
||||
|
||||
```
|
||||
T-0: Issue detected & reported
|
||||
T+5min: Severity assessed, hotfix branch created
|
||||
T+15: Fix implemented, code review started
|
||||
T+30: Approved & merged, tag created
|
||||
T+45: Deployed to production
|
||||
T+60: Smoke tests pass, monitoring enabled
|
||||
T+120: Declare emergency resolved, communicate
|
||||
T+1day: Follow-up communication
|
||||
```
|
||||
|
||||
**Total time: 2-4 hours from detection to resolution**
|
||||
|
||||
---
|
||||
|
||||
## 🚫 Common Mistakes to Avoid
|
||||
|
||||
❌ **Don't**:
|
||||
- Skip code review (even in emergency)
|
||||
- Add multiple unrelated fixes in one hotfix
|
||||
- Forget to update version number
|
||||
- Forget CHANGELOG entry
|
||||
- Deploy without testing
|
||||
- Forget to communicate with users
|
||||
|
||||
✅ **Do**:
|
||||
- Keep hotfix minimal and focused
|
||||
- Test every fix locally first
|
||||
- Get at least one approval
|
||||
- Update all version files
|
||||
- Deploy immediately after approval
|
||||
- Monitor actively for 2+ hours
|
||||
|
||||
---
|
||||
|
||||
## 📋 Hotfix Checklist
|
||||
|
||||
Copy for each emergency:
|
||||
|
||||
```
|
||||
Hotfix: [Product] v[Old Version] → v[New Version]
|
||||
|
||||
□ Severity assessed & documented
|
||||
□ Branch created from production tag
|
||||
□ Bug fixed & tested locally
|
||||
□ Version number updated (PATCH only)
|
||||
□ CHANGELOG entry added
|
||||
□ Commit message clear
|
||||
□ Code review requested (marked URGENT)
|
||||
□ Approval obtained
|
||||
□ Merged to main
|
||||
□ Production tag created
|
||||
□ Tag pushed to remote
|
||||
□ Deployed to production
|
||||
□ Smoke tests passed
|
||||
□ Error logs monitored (2+ hours)
|
||||
□ Users notified
|
||||
□ GitHub Release created
|
||||
□ Incident documented
|
||||
|
||||
Total Time: ___ minutes
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Post-Incident
|
||||
|
||||
After emergency is resolved:
|
||||
|
||||
1. **Document what happened**
|
||||
- Root cause analysis
|
||||
- Why it wasn't caught before
|
||||
- What testing was missed
|
||||
|
||||
2. **Schedule postmortem** (within 24 hours)
|
||||
- Review what went wrong
|
||||
- Discuss prevention
|
||||
- Update processes if needed
|
||||
|
||||
3. **Plan prevention**
|
||||
- Add test coverage
|
||||
- Update CI/CD checks
|
||||
- Improve monitoring
|
||||
|
||||
4. **Communicate findings**
|
||||
- Share with team
|
||||
- Update documentation
|
||||
- Prevent recurrence
|
||||
|
||||
---
|
||||
|
||||
## 📞 Emergency Contacts
|
||||
|
||||
When issue detected:
|
||||
|
||||
1. **Notify**:
|
||||
- Release Engineer
|
||||
- DevOps
|
||||
- Product Owner
|
||||
- Affected Team
|
||||
|
||||
2. **Communication Channel**:
|
||||
- Slack: #emergency-releases
|
||||
- Time-sensitive decisions on call
|
||||
|
||||
3. **Decision Maker**:
|
||||
- Product Owner approves rollback vs hotfix
|
||||
- Release Engineer executes
|
||||
- DevOps monitors infrastructure
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related
|
||||
|
||||
- [OVERALL_RELEASE_PLAN.md](./OVERALL_RELEASE_PLAN.md) - Main release strategy
|
||||
- [MOBILE_RELEASE_PLAN.md](./MOBILE_RELEASE_PLAN.md) - Mobile-specific process
|
||||
- [../../CHANGELOG.md](../../CHANGELOG.md) - Version history
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2026-03-05
|
||||
**Severity Levels**:
|
||||
- 🔴 CRITICAL: Service down, data loss, security (< 1 hour)
|
||||
- 🟠 HIGH: Major feature broken, workaround available (< 4 hours)
|
||||
- 🟡 MEDIUM: Minor feature affected (next release OK)
|
||||
564
docs/RELEASE/MOBILE_RELEASE_PLAN.md
Normal file
564
docs/RELEASE/MOBILE_RELEASE_PLAN.md
Normal file
@@ -0,0 +1,564 @@
|
||||
# Mobile App Release Plan
|
||||
|
||||
**For Staff Mobile & Client Mobile Apps**
|
||||
|
||||
---
|
||||
|
||||
## 📱 Overview
|
||||
|
||||
This document covers release procedures for:
|
||||
|
||||
- **Staff Mobile App** (aka "Worker Mobile") - `krow-withus-worker-mobile`
|
||||
- **Client Mobile App** - `krow-withus-client-mobile`
|
||||
|
||||
Both apps:
|
||||
- Built with Flutter
|
||||
- Distributed to iOS & Android app stores
|
||||
- Maintain independent versions
|
||||
- Have independent CHANGELOGs
|
||||
- Share backend infrastructure
|
||||
|
||||
---
|
||||
|
||||
## 🏷️ Tag & Release Naming
|
||||
|
||||
### Tag Format
|
||||
|
||||
```
|
||||
krow-withus-<app>-mobile/<environment>-v<major>.<minor>.<patch>
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
**Staff Mobile (Worker Mobile)**
|
||||
```
|
||||
krow-withus-worker-mobile/dev-v0.1.0
|
||||
krow-withus-worker-mobile/stage-v0.2.0
|
||||
krow-withus-worker-mobile/prod-v1.0.0
|
||||
krow-withus-worker-mobile/prod-v1.0.1-hotfix.1
|
||||
```
|
||||
|
||||
**Client Mobile**
|
||||
```
|
||||
krow-withus-client-mobile/dev-v0.1.0
|
||||
krow-withus-client-mobile/stage-v0.2.0
|
||||
krow-withus-client-mobile/prod-v1.0.0
|
||||
```
|
||||
|
||||
### GitHub Release Names
|
||||
|
||||
```
|
||||
Krow With Us - Worker Mobile - DEV - v0.1.0
|
||||
Krow With Us - Worker Mobile - STAGE - v0.2.0
|
||||
Krow With Us - Worker Mobile - PROD - v1.0.0
|
||||
|
||||
Krow With Us - Client Mobile - DEV - v0.1.0
|
||||
Krow With Us - Client Mobile - STAGE - v0.2.0
|
||||
Krow With Us - Client Mobile - PROD - v1.0.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📝 CHANGELOG Management
|
||||
|
||||
### Location
|
||||
|
||||
Each app has its own CHANGELOG in the `apps/mobile/` directory structure:
|
||||
|
||||
```
|
||||
apps/mobile/
|
||||
├── packages/
|
||||
│ ├── features/
|
||||
│ │ ├── staff/
|
||||
│ │ │ ├── authentication/CHANGELOG.md
|
||||
│ │ │ ├── home/CHANGELOG.md
|
||||
│ │ │ ├── payments/CHANGELOG.md
|
||||
│ │ │ ├── shifts/CHANGELOG.md
|
||||
│ │ │ └── ... (other staff features)
|
||||
│ │ └── client/
|
||||
│ │ ├── dashboard/CHANGELOG.md
|
||||
│ │ ├── orders/CHANGELOG.md
|
||||
│ │ └── ... (other client features)
|
||||
│ └── ... (other packages)
|
||||
├── apps/
|
||||
│ ├── staff_app/CHANGELOG.md ← Staff app root
|
||||
│ └── client_app/CHANGELOG.md ← Client app root
|
||||
└── CHANGELOG.md ← Consolidated (optional)
|
||||
```
|
||||
|
||||
### App-Level CHANGELOG Format
|
||||
|
||||
**File**: `apps/mobile/apps/staff_app/CHANGELOG.md`
|
||||
|
||||
```markdown
|
||||
# Staff Mobile App - Change Log
|
||||
|
||||
## [0.2.0] - 2026-03-15
|
||||
|
||||
### Added
|
||||
- Feature X implementation
|
||||
- Feature Y enhancement
|
||||
- New UI component Z
|
||||
|
||||
### Fixed
|
||||
- Bug fix for issue #123
|
||||
- Crash when loading payments
|
||||
|
||||
### Changed
|
||||
- Updated design system
|
||||
- Improved performance
|
||||
|
||||
### Deprecated
|
||||
- Removed old API endpoint
|
||||
|
||||
## [0.1.0] - 2026-03-01
|
||||
|
||||
### Added
|
||||
- Initial release
|
||||
- Authentication with phone & OTP
|
||||
- Shift browsing and booking
|
||||
- Clock in/out functionality
|
||||
- Payment history view
|
||||
```
|
||||
|
||||
### Consolidated CHANGELOG (Optional)
|
||||
|
||||
**File**: `apps/mobile/CHANGELOG.md` (at root of mobile folder)
|
||||
|
||||
High-level overview of both apps:
|
||||
|
||||
```markdown
|
||||
# Krow Workforce - Mobile Apps - Change Log
|
||||
|
||||
## Staff Mobile v0.2.0 + Client Mobile v0.1.0 - 2026-03-15
|
||||
|
||||
### Staff Mobile v0.2.0
|
||||
- Feature improvements
|
||||
- Bug fixes
|
||||
|
||||
### Client Mobile v0.1.0
|
||||
- Initial release
|
||||
|
||||
## Previous versions...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📝 Version Files
|
||||
|
||||
### Staff Mobile App
|
||||
|
||||
**Primary Version File**: `apps/mobile/apps/staff_app/pubspec.yaml`
|
||||
|
||||
```yaml
|
||||
name: staff_app
|
||||
description: "Krow With Us - Staff App"
|
||||
|
||||
# Version format: MAJOR.MINOR.PATCH+BUILD_NUMBER
|
||||
version: 0.1.0+1
|
||||
|
||||
environment:
|
||||
sdk: '>=3.10.0 <4.0.0'
|
||||
flutter: '>=3.38.0 <4.0.0'
|
||||
```
|
||||
|
||||
**Rules**:
|
||||
- Update version before each release
|
||||
- Bump build number (+1) every build
|
||||
- SemVer only for version part (before +)
|
||||
|
||||
### Client Mobile App
|
||||
|
||||
**Primary Version File**: `apps/mobile/apps/client_app/pubspec.yaml`
|
||||
|
||||
```yaml
|
||||
name: client_app
|
||||
description: "Krow With Us - Client App"
|
||||
|
||||
version: 0.1.0+1
|
||||
|
||||
environment:
|
||||
sdk: '>=3.10.0 <4.0.0'
|
||||
flutter: '>=3.38.0 <4.0.0'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Release Workflow
|
||||
|
||||
### Step 1: Create Release Branch
|
||||
|
||||
```bash
|
||||
cd /Users/achintha/Documents/GitHub/krow-workforce
|
||||
|
||||
# For Staff Mobile
|
||||
git checkout -b release/staff-mobile-v0.2.0
|
||||
|
||||
# For Client Mobile
|
||||
git checkout -b release/client-mobile-v0.2.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: Update Version Numbers
|
||||
|
||||
#### Staff Mobile Example (v0.1.0 → v0.2.0)
|
||||
|
||||
**File**: `apps/mobile/apps/staff_app/pubspec.yaml`
|
||||
|
||||
```yaml
|
||||
# Old
|
||||
version: 0.1.0+5
|
||||
|
||||
# New
|
||||
version: 0.2.0+6
|
||||
```
|
||||
|
||||
#### Client Mobile Example (v0.1.0 → v0.2.0)
|
||||
|
||||
**File**: `apps/mobile/apps/client_app/pubspec.yaml`
|
||||
|
||||
```yaml
|
||||
# Old
|
||||
version: 0.1.0+3
|
||||
|
||||
# New
|
||||
version: 0.2.0+4
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: Update CHANGELOG
|
||||
|
||||
**File**: `apps/mobile/apps/staff_app/CHANGELOG.md`
|
||||
|
||||
Add entry at **top**:
|
||||
|
||||
```markdown
|
||||
# Staff Mobile App - Change Log
|
||||
|
||||
## [0.2.0] - 2026-03-05
|
||||
|
||||
### Added
|
||||
- New shift details page with profile gating
|
||||
- Benefits overview section
|
||||
- Auto-match functionality
|
||||
|
||||
### Fixed
|
||||
- Payment history display bug
|
||||
- Clock-in location verification
|
||||
|
||||
### Changed
|
||||
- Updated design system components
|
||||
- Improved shift booking flow
|
||||
|
||||
## [0.1.0] - 2026-02-15
|
||||
...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: Commit Changes
|
||||
|
||||
```bash
|
||||
cd /Users/achintha/Documents/GitHub/krow-workforce
|
||||
|
||||
# Stage changes
|
||||
git add apps/mobile/apps/staff_app/pubspec.yaml
|
||||
git add apps/mobile/apps/staff_app/CHANGELOG.md
|
||||
|
||||
# Commit
|
||||
git commit -m "chore(staff-mobile): bump version to 0.2.0
|
||||
|
||||
- Updated pubspec.yaml version: 0.1.0 → 0.2.0
|
||||
- Updated build number: 5 → 6
|
||||
- Updated CHANGELOG.md with v0.2.0 changes"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 5: Create Pull Request
|
||||
|
||||
```bash
|
||||
# Push release branch
|
||||
git push origin release/staff-mobile-v0.2.0
|
||||
|
||||
# Create PR (GitHub CLI)
|
||||
gh pr create \
|
||||
--title "Release: Staff Mobile v0.2.0" \
|
||||
--body "## Release: Staff Mobile v0.2.0
|
||||
|
||||
### Changes
|
||||
- See CHANGELOG.md for full list
|
||||
|
||||
### Testing
|
||||
- [ ] All tests passing
|
||||
- [ ] Manual testing complete
|
||||
- [ ] CodeMagic build successful
|
||||
|
||||
### Checklist
|
||||
- [x] Version updated
|
||||
- [x] CHANGELOG updated
|
||||
- [x] Branch created from main
|
||||
- [ ] Approved by team lead"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 6: Merge to Main
|
||||
|
||||
Once PR is approved:
|
||||
|
||||
```bash
|
||||
# Switch to main
|
||||
git checkout main
|
||||
git pull origin main
|
||||
|
||||
# Merge (fast-forward only)
|
||||
git merge --ff-only release/staff-mobile-v0.2.0
|
||||
|
||||
# Push to remote
|
||||
git push origin main
|
||||
|
||||
# Delete release branch
|
||||
git push origin --delete release/staff-mobile-v0.2.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 7: Create Git Tag
|
||||
|
||||
```bash
|
||||
# For DEV release
|
||||
git tag -a krow-withus-worker-mobile/dev-v0.2.0 \
|
||||
-m "Staff Mobile v0.2.0 - Dev Release
|
||||
|
||||
Features:
|
||||
- Shift details improvements
|
||||
- Benefits overview
|
||||
- Auto-match functionality
|
||||
|
||||
Testing:
|
||||
- All unit tests passing
|
||||
- Manual QA on dev environment"
|
||||
|
||||
# For STAGE release
|
||||
git tag -a krow-withus-worker-mobile/stage-v0.2.0 \
|
||||
-m "Staff Mobile v0.2.0 - Stage Release"
|
||||
|
||||
# For PROD release
|
||||
git tag -a krow-withus-worker-mobile/prod-v0.2.0 \
|
||||
-m "Staff Mobile v0.2.0 - Production Release"
|
||||
```
|
||||
|
||||
**Push tags**:
|
||||
|
||||
```bash
|
||||
git push origin krow-withus-worker-mobile/dev-v0.2.0
|
||||
git push origin krow-withus-worker-mobile/stage-v0.2.0
|
||||
git push origin krow-withus-worker-mobile/prod-v0.2.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 8: Create GitHub Release
|
||||
|
||||
1. Go to: GitHub → Releases → Draft a new release
|
||||
2. Fill in:
|
||||
|
||||
```
|
||||
Tag version: krow-withus-worker-mobile/dev-v0.2.0
|
||||
|
||||
Release title:
|
||||
Krow With Us - Worker Mobile - DEV - v0.2.0
|
||||
|
||||
Description:
|
||||
|
||||
## 🎯 What's New in v0.2.0
|
||||
|
||||
### ✨ Features
|
||||
- Shift details page with profile completion gating
|
||||
- Benefits overview with sick leave tracking
|
||||
- Auto-match shift recommendations
|
||||
|
||||
### 🔧 Improvements
|
||||
- Faster payment history loading
|
||||
- Better shift booking UX
|
||||
- Improved clock-in reliability
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
- Fixed payment display date issue
|
||||
- Fixed location verification on iOS 15+
|
||||
- Fixed crash when no shifts available
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
**iOS**: Download via TestFlight (internal) or App Store
|
||||
**Android**: Download via Play Store
|
||||
|
||||
## 🔗 Dependencies
|
||||
|
||||
Requires:
|
||||
- Backend API v0.1.0+
|
||||
- DataConnect schema v0.3.0+
|
||||
|
||||
## ⚠️ Known Issues
|
||||
|
||||
- Location permissions take 5-10 seconds on first install
|
||||
- Workaround: Grant permissions in Settings app
|
||||
|
||||
## 📝 Notes for QA
|
||||
|
||||
- Test on actual device, not emulator
|
||||
- Verify clock-in with GPS enabled
|
||||
- Test all payment history edge cases
|
||||
|
||||
---
|
||||
|
||||
Release Date: 2026-03-05
|
||||
Build Number: 6
|
||||
```
|
||||
|
||||
3. **Optional**: Attach build artifacts (APK/AAB from CodeMagic)
|
||||
4. **Click**: "Publish release"
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Deployment Flow
|
||||
|
||||
### Dev Release → Staging
|
||||
|
||||
After dev is tested:
|
||||
|
||||
```bash
|
||||
# Create stage tag from same commit
|
||||
git tag -a krow-withus-worker-mobile/stage-v0.2.0 \
|
||||
krow-withus-worker-mobile/dev-v0.2.0 \
|
||||
-m "Staff Mobile v0.2.0 - Stage Release"
|
||||
|
||||
git push origin krow-withus-worker-mobile/stage-v0.2.0
|
||||
|
||||
# Deploy using CodeMagic or manual process
|
||||
```
|
||||
|
||||
### Staging Release → Production
|
||||
|
||||
After QA approval:
|
||||
|
||||
```bash
|
||||
# Create prod tag from same commit
|
||||
git tag -a krow-withus-worker-mobile/prod-v0.2.0 \
|
||||
krow-withus-worker-mobile/stage-v0.2.0 \
|
||||
-m "Worker Mobile v0.2.0 - Production Release"
|
||||
|
||||
git push origin krow-withus-worker-mobile/prod-v0.2.0
|
||||
|
||||
# Deploy to production
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📱 App Store Distribution
|
||||
|
||||
### iOS App Store
|
||||
|
||||
**Version Name**: Match pubspec.yaml version (0.2.0)
|
||||
**Build Number**: Match pubspec.yaml build number (+6)
|
||||
|
||||
**Steps**:
|
||||
1. Ensure TestFlight build passed
|
||||
2. Submit to App Review
|
||||
3. Apple reviews (3-5 days)
|
||||
4. Release to users (can be phased)
|
||||
|
||||
### Google Play Store
|
||||
|
||||
**Version Name**: Match pubspec.yaml version (0.2.0)
|
||||
**Version Code**: Match pubspec.yaml build number (6)
|
||||
|
||||
**Steps**:
|
||||
1. Upload APK/AAB from CodeMagic
|
||||
2. Fill in release notes (from CHANGELOG)
|
||||
3. Submit for review
|
||||
4. Google reviews (hours to 24h)
|
||||
5. Release to users (can be phased, e.g., 10% then 100%)
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Pre-Release Checklist
|
||||
|
||||
Before creating tags:
|
||||
|
||||
- [ ] All PRs merged to main
|
||||
- [ ] Code review complete
|
||||
- [ ] Tests passing (unit, widget, integration)
|
||||
- [ ] No lint/analysis errors: `flutter analyze`
|
||||
- [ ] Pubspec.yaml version updated
|
||||
- [ ] Build number incremented
|
||||
- [ ] CHANGELOG.md updated with date
|
||||
- [ ] Screenshots prepared (fresh)
|
||||
- [ ] Release notes drafted
|
||||
- [ ] No hardcoded strings (use translations)
|
||||
- [ ] No debug prints remaining
|
||||
- [ ] Performance acceptable (app launch < 3 seconds)
|
||||
- [ ] Screen lock/unlock works
|
||||
- [ ] Deep links tested
|
||||
- [ ] Notifications working
|
||||
- [ ] GPS/location working
|
||||
- [ ] Camera permissions working
|
||||
- [ ] All user-facing text reviewed
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Release Cadence
|
||||
|
||||
### Development Releases (dev)
|
||||
|
||||
- **Frequency**: Weekly
|
||||
- **Day**: Monday 10:00 UTC
|
||||
- **Process**: Quick, test in dev only
|
||||
|
||||
### Staging Releases (stage)
|
||||
|
||||
- **Frequency**: Bi-weekly (on sprint/feature completion)
|
||||
- **Day**: Wednesday before production
|
||||
- **Process**: Full QA testing, 1 week in staging
|
||||
|
||||
### Production Releases (prod)
|
||||
|
||||
- **Frequency**: Monthly (end of sprint)
|
||||
- **Day**: Sunday/Monday morning (low traffic)
|
||||
- **Process**: Full validation, market distribution
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related
|
||||
|
||||
- [OVERALL_RELEASE_PLAN.md](./OVERALL_RELEASE_PLAN.md) - General strategy
|
||||
- [HOTFIX_PROCESS.md](./HOTFIX_PROCESS.md) - Emergency procedures
|
||||
- [../../CHANGELOG.md](../../CHANGELOG.md) - Root-level history
|
||||
|
||||
---
|
||||
|
||||
## 📞 Common Questions
|
||||
|
||||
**Q: What if I need to release just one app (not both)?**
|
||||
A: Completely fine! Each app is independent. Release when ready.
|
||||
|
||||
**Q: Do I need to update the root CHANGELOG?**
|
||||
A: Optional. If you do, keep it high-level and reference app-specific CHANGELOGs.
|
||||
|
||||
**Q: What about shared packages inside mobile/?**
|
||||
A: If shared package updated, mention in both app CHANGELOGs.
|
||||
|
||||
**Q: How do I handle breaking changes?**
|
||||
A: MAJOR version bump (0.x → 1.x) and clearly document in CHANGELOG.
|
||||
|
||||
**Q: Can I release dev and stage on different days?**
|
||||
A: Yes, no fixed schedule for dev/stage. Prod should be consistent (Sundays).
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2026-03-05
|
||||
**Owner**: Mobile Engineering Team
|
||||
**Status**: Active
|
||||
452
docs/RELEASE/OVERALL_RELEASE_PLAN.md
Normal file
452
docs/RELEASE/OVERALL_RELEASE_PLAN.md
Normal file
@@ -0,0 +1,452 @@
|
||||
# KROW Workforce - Overall Release Plan
|
||||
|
||||
**Document Version**: 1.0
|
||||
**Created**: 2026-03-05
|
||||
**Last Updated**: 2026-03-05
|
||||
**Product Scope**: All products (Mobile, Web, Backend, Database)
|
||||
|
||||
---
|
||||
|
||||
## 📋 Overview
|
||||
|
||||
This document outlines the release strategy for KROW Workforce monorepo containing 5 products:
|
||||
|
||||
1. **Staff Mobile App** (Flutter - iOS/Android)
|
||||
2. **Client Mobile App** (Flutter - iOS/Android)
|
||||
3. **Web Dashboard** (React/Vite)
|
||||
4. **Backend Services** (Node.js - Command API, Core API)
|
||||
5. **Database** (Firebase Data Connect with PostgreSQL)
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Versioning Strategy
|
||||
|
||||
### Semantic Versioning (SemVer)
|
||||
|
||||
All products use **Semantic Versioning 2.0.0**:
|
||||
|
||||
```
|
||||
MAJOR.MINOR.PATCH-QUALIFIER
|
||||
0.1.0
|
||||
1.2.3-rc.1
|
||||
```
|
||||
|
||||
- **MAJOR** (0→1): Breaking changes, major features
|
||||
- **MINOR** (1→2): Backward-compatible new features
|
||||
- **PATCH** (3→4): Bug fixes, minor improvements
|
||||
- **QUALIFIER** (optional): `-rc.1`, `-beta.1`, `-hotfix.1`
|
||||
|
||||
### Version Independence
|
||||
|
||||
Each product maintains **independent versioning**:
|
||||
- Products release on their own schedule
|
||||
- No requirement to synchronize versions
|
||||
- Can release major updates independently
|
||||
|
||||
---
|
||||
|
||||
## 🏷️ Git Tag Naming Convention
|
||||
|
||||
### Standard Format
|
||||
|
||||
```
|
||||
<product>/<environment>-v<major>.<minor>.<patch>
|
||||
```
|
||||
|
||||
### Products & Environments
|
||||
|
||||
| Product | Tag Prefix | Environments |
|
||||
|---------|-----------|---------------|
|
||||
| Staff Mobile | `krow-withus-worker-mobile` | dev, stage, prod |
|
||||
| Client Mobile | `krow-withus-client-mobile` | dev, stage, prod |
|
||||
| Web Dashboard | `web-dashboard` | dev, stage, prod |
|
||||
| Command API | `command-api` | dev, stage, prod |
|
||||
| Core API | `core-api` | dev, stage, prod |
|
||||
| DataConnect | `dataconnect` | stage, prod |
|
||||
|
||||
### Environments
|
||||
|
||||
- **dev**: Development releases (daily/weekly), unstable
|
||||
- **stage**: Staging releases (bi-weekly), pre-production testing
|
||||
- **prod**: Production releases (monthly), stable, customer-facing
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
krow-withus-worker-mobile/dev-v0.1.0
|
||||
krow-withus-client-mobile/stage-v0.2.0
|
||||
web-dashboard/prod-v1.0.0
|
||||
command-api/dev-v0.2.1
|
||||
core-api/prod-v0.1.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📅 Release Cadence
|
||||
|
||||
### Development Releases (dev)
|
||||
|
||||
- **Frequency**: Weekly or as-needed
|
||||
- **Scope**: Feature completions, bug fixes
|
||||
- **Duration**: Not guaranteed stable
|
||||
- **Deployment**: Dev environment only
|
||||
- **Who**: Development team
|
||||
|
||||
### Staging Releases (stage)
|
||||
|
||||
- **Frequency**: Bi-weekly (typically mid/end of sprint)
|
||||
- **Scope**: Sprint completion, feature milestones
|
||||
- **Duration**: 1-2 weeks stability expected
|
||||
- **Deployment**: Staging environment for QA
|
||||
- **Who**: QA team validates
|
||||
|
||||
### Production Releases (prod)
|
||||
|
||||
- **Frequency**: Monthly or sprint-based
|
||||
- **Scope**: Feature milestone completion, critical fixes
|
||||
- **Duration**: 4+ weeks standard support
|
||||
- **Deployment**: Production environment (customer-facing)
|
||||
- **Who**: Product owner approves, DevOps deploys
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Product Dependency & Deployment Order
|
||||
|
||||
### Critical Path (for synchronized releases)
|
||||
|
||||
Deploy in this order:
|
||||
|
||||
1. **DataConnect Schema** (if schema changed)
|
||||
- Deploy schema changes first
|
||||
- All APIs depend on schema availability
|
||||
|
||||
2. **Backend Services** (parallel OK)
|
||||
- Command API
|
||||
- Core API
|
||||
- Both can deploy simultaneously
|
||||
|
||||
3. **Web Dashboard**
|
||||
- Can deploy once backend ready
|
||||
- Test API endpoints stable
|
||||
|
||||
4. **Mobile Apps** (parallel OK)
|
||||
- Staff Mobile
|
||||
- Client Mobile
|
||||
- Both can deploy simultaneously, independent of web
|
||||
|
||||
### Independent Releases
|
||||
|
||||
Products **can release independently** if:
|
||||
- No backend schema changes
|
||||
- No breaking API changes
|
||||
- No data migrations required
|
||||
|
||||
Example: Staff Mobile can release UI improvements without web/backend changes.
|
||||
|
||||
---
|
||||
|
||||
## 📝 CHANGELOG Management
|
||||
|
||||
### Location & Structure
|
||||
|
||||
Each major product maintains its own CHANGELOG:
|
||||
|
||||
```
|
||||
apps/mobile/packages/features/staff/*/CHANGELOG.md
|
||||
apps/mobile/packages/features/client/*/CHANGELOG.md
|
||||
apps/web/CHANGELOG.md
|
||||
backend/command-api/CHANGELOG.md
|
||||
backend/core-api/CHANGELOG.md
|
||||
CHANGELOG.md (root - high-level overview)
|
||||
```
|
||||
|
||||
### Format
|
||||
|
||||
```markdown
|
||||
| Date | Version | Change |
|
||||
|------|---------|--------|
|
||||
| 2026-03-05 | 0.1.0 | Initial release - [feature list] |
|
||||
```
|
||||
|
||||
### What to Track
|
||||
|
||||
- Features added
|
||||
- Bugs fixed
|
||||
- Breaking changes (clearly marked ⚠️)
|
||||
- Dependencies upgraded
|
||||
- Migration steps (if applicable)
|
||||
|
||||
---
|
||||
|
||||
## ✅ Release Checklist
|
||||
|
||||
### Pre-Release (48 hours before)
|
||||
|
||||
- [ ] All PRs merged to main
|
||||
- [ ] Code review complete
|
||||
- [ ] All tests passing (unit, integration, E2E)
|
||||
- [ ] No lint/type errors
|
||||
- [ ] Mobile builds succeed (CodeMagic)
|
||||
- [ ] Performance benchmarks acceptable
|
||||
- [ ] Security scan completed
|
||||
- [ ] CHANGELOG.md updated with all changes
|
||||
- [ ] Documentation updated
|
||||
- [ ] Team notified of pending release
|
||||
|
||||
### Release Day
|
||||
|
||||
- [ ] Update version numbers in all relevant files
|
||||
- [ ] Update CHANGELOG with date
|
||||
- [ ] Git commit: `git commit -m "chore: bump version to X.Y.Z"`
|
||||
- [ ] Git push changes to main
|
||||
- [ ] Create git tag: `git tag -a <product>/<env>-v<version> -m "Release message"`
|
||||
- [ ] Push tags: `git push origin <tag-name>`
|
||||
- [ ] Deploy to target environment
|
||||
- [ ] Smoke tests pass
|
||||
- [ ] Create GitHub Release page
|
||||
- [ ] Notify stakeholders
|
||||
|
||||
### Post-Release (24 hours)
|
||||
|
||||
- [ ] Monitor error logs
|
||||
- [ ] Verify all features work end-to-end
|
||||
- [ ] Performance is acceptable
|
||||
- [ ] No regressions reported
|
||||
- [ ] Users updated if needed
|
||||
- [ ] Document any issues
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Protected Tags
|
||||
|
||||
### Branch Protection Rules
|
||||
|
||||
**Production tags require approval:**
|
||||
|
||||
- Tag pattern: `*/prod-v*`
|
||||
- Require pull request review (1+ approval)
|
||||
- Require status checks to pass
|
||||
- Prevent force pushes
|
||||
- Disable deletions
|
||||
|
||||
**Staging tags recommended:**
|
||||
|
||||
- Tag pattern: `*/stage-v*`
|
||||
- Consider: Require at least 1 approval
|
||||
- Status checks should pass
|
||||
|
||||
**Dev tags open:**
|
||||
|
||||
- Tag pattern: `*/dev-v*`
|
||||
- No restrictions
|
||||
- Allow fast iteration
|
||||
|
||||
---
|
||||
|
||||
## 🚨 Rollback Procedures
|
||||
|
||||
### For Production Issues
|
||||
|
||||
**If critical issue detected:**
|
||||
|
||||
1. **Identify** the product and issue
|
||||
2. **Assess** impact and severity
|
||||
3. **Decide** rollback vs hotfix
|
||||
- Rollback: Undo entire release
|
||||
- Hotfix: Fix and re-release (see HOTFIX_PROCESS.md)
|
||||
4. **Execute** rollback:
|
||||
```bash
|
||||
# Revert commit
|
||||
git revert <commit-hash> -m 1
|
||||
git push origin main
|
||||
|
||||
# Or switch traffic back to previous version
|
||||
# (depends on deployment infrastructure)
|
||||
```
|
||||
5. **Communicate** with users
|
||||
6. **Plan** hotfix or next release
|
||||
|
||||
### Time Windows
|
||||
|
||||
- **Awareness**: 15-30 minutes (monitoring)
|
||||
- **Decision**: 15-30 minutes (severity assessment)
|
||||
- **Execution**: 15-60 minutes (rollback deployment)
|
||||
- **Verification**: 30-60 minutes (smoke tests)
|
||||
- **Communication**: Immediate + 24h updates
|
||||
|
||||
**Total**: 2-4 hours from detection to stable state
|
||||
|
||||
---
|
||||
|
||||
## 📊 Release Templates & Tools
|
||||
|
||||
### Git Commands
|
||||
|
||||
```bash
|
||||
# Create tag
|
||||
git tag -a krow-withus-worker-mobile/dev-v0.1.0 \
|
||||
-m "Staff Mobile v0.1.0 - Feature X"
|
||||
|
||||
# Push tag
|
||||
git push origin krow-withus-worker-mobile/dev-v0.1.0
|
||||
|
||||
# View tags for product
|
||||
git tag -l "krow-withus-worker-mobile/*" --sort=-version:refname
|
||||
|
||||
# See what's in a tag
|
||||
git show krow-withus-worker-mobile/dev-v0.1.0
|
||||
|
||||
# Delete tag (if mistake)
|
||||
git tag -d krow-withus-worker-mobile/dev-v0.1.0
|
||||
git push origin --delete krow-withus-worker-mobile/dev-v0.1.0
|
||||
```
|
||||
|
||||
### GitHub Release Template
|
||||
|
||||
```markdown
|
||||
# Krow With Us - Worker Mobile - DEV - v0.1.0
|
||||
|
||||
**Release Date**: [Date]
|
||||
**Environment**: Development
|
||||
|
||||
## What's New
|
||||
|
||||
### ✨ Features
|
||||
- Feature 1 description
|
||||
- Feature 2 description
|
||||
|
||||
### 🔧 Improvements
|
||||
- Improvement 1
|
||||
- Improvement 2
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
- Bug fix 1
|
||||
- Bug fix 2
|
||||
|
||||
## Dependencies
|
||||
|
||||
Requires:
|
||||
- Backend API v0.1.0 or higher
|
||||
- DataConnect schema v0.3.0 (if updated)
|
||||
|
||||
## Installation
|
||||
|
||||
[Download links & instructions]
|
||||
|
||||
## Known Issues
|
||||
|
||||
- Issue 1: [desc] (Workaround: ...)
|
||||
|
||||
## Support
|
||||
|
||||
contact: support@krow-workforce.com
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Hotfix Releases
|
||||
|
||||
See [HOTFIX_PROCESS.md](./HOTFIX_PROCESS.md) for emergency procedures.
|
||||
|
||||
Quick summary:
|
||||
1. Branch from production tag
|
||||
2. Fix the issue
|
||||
3. Bump PATCH version only
|
||||
4. Test and deploy immediately
|
||||
5. Create hotfix tag
|
||||
|
||||
---
|
||||
|
||||
## 📱 Mobile-Specific Release Process
|
||||
|
||||
See [MOBILE_RELEASE_PLAN.md](./MOBILE_RELEASE_PLAN.md) for detailed mobile app process including:
|
||||
- Staff Mobile vs Client Mobile differences
|
||||
- Build number management
|
||||
- CodeMagic integration
|
||||
- App store distribution
|
||||
- CHANGELOG per app
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Release Coordination
|
||||
|
||||
### Single Product Release
|
||||
|
||||
1. Update version files
|
||||
2. Update CHANGELOG
|
||||
3. Commit & push
|
||||
4. Create tag
|
||||
5. Deploy
|
||||
6. Create GitHub Release
|
||||
|
||||
**Time**: 30-45 minutes (excluding testing)
|
||||
|
||||
### Multi-Product Release (e.g., v1.0.0)
|
||||
|
||||
**Pre-release phase** (1 week before):
|
||||
- Code freeze announced
|
||||
- QA testing begins
|
||||
- No new features merged
|
||||
|
||||
**Release phase** (2-3 days):
|
||||
- Staging release (all products)
|
||||
- QA validation
|
||||
- Product owner sign-off
|
||||
|
||||
**Production phase** (1 day):
|
||||
- Deploy in dependency order
|
||||
- Smoke tests each product
|
||||
- Monitor 24 hours
|
||||
- User communication
|
||||
|
||||
**Time**: 5-7 days total, 4 hours active deployment
|
||||
|
||||
---
|
||||
|
||||
## 📞 Roles & Responsibilities
|
||||
|
||||
| Role | Responsibility |
|
||||
|------|-----------------|
|
||||
| **Developer** | Keep code release-ready, update versions |
|
||||
| **QA** | Test staging releases, validate prod |
|
||||
| **Release Engineer** | Create tags, manage deployment, monitor |
|
||||
| **Product Owner** | Approve releases, communicate timeline |
|
||||
| **DevOps** | Infrastructure ready, deployment scripts |
|
||||
|
||||
---
|
||||
|
||||
## 📊 Success Metrics
|
||||
|
||||
Track these per release:
|
||||
|
||||
- **Lead Time**: Time from code commit to production
|
||||
- **Deployment Frequency**: How often you release
|
||||
- **Change Failure Rate**: % of releases needing rollback
|
||||
- **Time to Recovery**: Time to fix production issues
|
||||
- **User Adoption**: % of users on latest version
|
||||
|
||||
---
|
||||
|
||||
## 📚 Related Documentation
|
||||
|
||||
- [MOBILE_RELEASE_PLAN.md](./MOBILE_RELEASE_PLAN.md) - Mobile app releases
|
||||
- [HOTFIX_PROCESS.md](./HOTFIX_PROCESS.md) - Emergency procedures
|
||||
- [../../RELEASE_STRATEGY.md](../../RELEASE_STRATEGY.md) - Original detailed guide
|
||||
- [../../CHANGELOG.md](../../CHANGELOG.md) - Root version history
|
||||
|
||||
---
|
||||
|
||||
## ✅ Implementation Status
|
||||
|
||||
- ✅ Versioning strategy: SemVer
|
||||
- ✅ Environments: dev, stage, prod
|
||||
- ✅ Tag naming: Product-specific with brand prefix
|
||||
- ✅ Product dependencies: Defined
|
||||
- ✅ Release cadence: 3 levels
|
||||
- ⏳ GitHub Actions: To be set up
|
||||
- ⏳ Deployment automation: To be set up
|
||||
|
||||
---
|
||||
|
||||
**Next Step**: Review [MOBILE_RELEASE_PLAN.md](./MOBILE_RELEASE_PLAN.md) for app-specific process.
|
||||
|
||||
Reference in New Issue
Block a user