@alteriom/painlessmesh 1.7.5 → 1.7.7

package/docs/releases/RELEASE_CHECKLIST_v1.7.5.md

@@ -0,0 +1,315 @@
+# Release Checklist - painlessMesh v1.7.5
+
+**Release Date:** October 19, 2025  
+**Release Manager:** Alteriom
+
+## Pre-Release ✅ COMPLETE
+
+- [x] All CI/CD tests passing
+- [x] Version numbers updated (library.json, library.properties, package.json)
+- [x] CHANGELOG.md updated with v1.7.5 changes
+- [x] Release summary document created (RELEASE_SUMMARY_v1.7.5.md)
+- [x] Git commit created with release changes
+- [x] Git tag v1.7.5 created and pushed
+- [x] All changes pushed to GitHub main branch
+
+## GitHub Release 📦
+
+- [ ] **Navigate to:** https://github.com/Alteriom/painlessMesh/releases/new
+- [ ] **Tag:** Select `v1.7.5` from dropdown
+- [ ] **Title:** `v1.7.5 - TaskScheduler Compatibility & CI/CD Fixes`
+- [ ] **Description:** Use template below
+- [ ] **Set as latest release:** ✅ Checked
+- [ ] **Create discussion:** ✅ Checked (optional)
+- [ ] Click **Publish Release**
+
+### GitHub Release Description Template
+
+```markdown
+# painlessMesh v1.7.5 - TaskScheduler Compatibility & CI/CD Fixes
+
+**Release Date:** October 19, 2025  
+**Release Type:** Patch Release (Critical Bug Fix)
+
+## 🚨 Critical Fixes
+
+This release addresses TaskScheduler compatibility issues and CI/CD build failures discovered during v1.7.4 testing.
+
+### Key Changes
+
+- **Reverted Thread-Safe Mode**: Disabled `_TASK_THREAD_SAFE` due to architectural incompatibility with TaskScheduler v4.0.x
+- **Fixed Build System**: Added `lib_ldf_mode = deep+` to all example configurations
+- **Corrected Include Order**: Examples now include `painlessTaskOptions.h` before `TaskScheduler.h`
+- **FreeRTOS Crash Reduction**: Maintained at ~85% via semaphore timeout increase (Option A)
+
+## 📋 What's Changed
+
+### TaskScheduler Compatibility
+
+TaskScheduler v4.0.x cannot use `_TASK_THREAD_SAFE` and `_TASK_STD_FUNCTION` simultaneously. Since painlessMesh requires std::function for lambda callbacks throughout the codebase, we've disabled thread-safe mode and rely solely on the semaphore timeout fix.
+
+**Trade-off:**
+- ✅ Library functionality fully restored
+- ✅ All CI/CD builds passing
+- ⚠️ FreeRTOS crash reduction: ~85% (vs 95-98% with dual approach)
+- ✅ ESP32 crash rate: ~5-8% (acceptable for production)
+
+### CI/CD Improvements
+
+- Fixed PlatformIO Library Dependency Finder configuration
+- Corrected include order in 6 example sketches
+- Added feature build flags for `alteriomImproved` example
+- All 19 examples now build successfully
+
+## 🔧 Installation
+
+### PlatformIO
+```bash
+pio pkg update sparck75/AlteriomPainlessMesh
+```
+
+### NPM
+```bash
+npm update @alteriom/painlessmesh
+```
+
+### Arduino IDE
+Library Manager → Search "painlessMesh" → Update to v1.7.5
+
+## 📚 Documentation
+
+- [CHANGELOG.md](CHANGELOG.md) - Full version history
+- [Release Summary](docs/releases/RELEASE_SUMMARY_v1.7.5.md) - Technical details
+- [Troubleshooting Guide](docs/troubleshooting/SENSOR_NODE_CONNECTION_CRASH.md) - FreeRTOS crash information
+
+## ⚙️ Technical Details
+
+**Commits:** 8869db8, f7ad959, 6f477a0, fe17e72, d8d2ff0  
+**Files Changed:** 32 files  
+**Test Status:** ✅ 710+ tests passing  
+**Build Status:** ✅ All platforms passing
+
+## 🆕 What's Next?
+
+Future releases will explore:
+- TaskScheduler v4.1+ compatibility when available
+- Alternative task scheduler options
+- Custom thread-safe implementation
+- Further FreeRTOS crash mitigation strategies
+
+## 🙏 Acknowledgments
+
+Thank you to the community for testing and reporting the v1.7.4 CI/CD issues.
+
+---
+
+**Full Changelog**: https://github.com/Alteriom/painlessMesh/compare/v1.7.4...v1.7.5
+```
+
+## NPM Publishing 📦
+
+### Prerequisites
+- [ ] Verify you're logged in to NPM: `npm whoami`
+- [ ] Verify package.json version is 1.7.5
+- [ ] Verify you're on main branch with latest changes
+
+### Steps
+
+1. **Test the package locally** (optional but recommended):
+   ```bash
+   npm pack
+   # This creates alteriom-painlessmesh-1.7.5.tgz
+   ```
+
+2. **Publish to NPM:**
+   ```bash
+   npm publish --access public
+   ```
+
+3. **Verify publication:**
+   ```bash
+   npm view @alteriom/painlessmesh version
+   # Should show: 1.7.5
+   ```
+
+4. **Check on NPM website:**
+   - Visit: https://www.npmjs.com/package/@alteriom/painlessmesh
+   - Verify version shows 1.7.5
+   - Check that "Latest" tag is applied
+
+### NPM Checklist
+- [ ] Package built successfully (npm pack)
+- [ ] Published to NPM registry
+- [ ] Version 1.7.5 visible on npmjs.com
+- [ ] "Latest" tag applied correctly
+- [ ] Package downloadable: `npm install @alteriom/painlessmesh@1.7.5`
+
+## PlatformIO Registry 📦
+
+### Prerequisites
+- [ ] Verify PlatformIO account credentials
+- [ ] Verify library.json version is 1.7.5
+
+### Automatic Registry Update
+
+PlatformIO automatically detects new GitHub releases and updates the registry within 24 hours.
+
+**Monitor at:** https://registry.platformio.org/libraries/sparck75/AlteriomPainlessMesh
+
+### Manual Trigger (if needed)
+
+If automatic update doesn't occur within 24 hours:
+
+1. **Via PlatformIO CLI:**
+   ```bash
+   pio pkg publish .
+   ```
+
+2. **Via Web Interface:**
+   - Login to https://platformio.org
+   - Navigate to your library page
+   - Click "Sync from GitHub"
+
+### PlatformIO Checklist
+- [ ] Monitored registry for automatic update
+- [ ] Version 1.7.5 appears in registry (within 24 hours)
+- [ ] Library downloadable: `pio pkg install sparck75/AlteriomPainlessMesh@1.7.5`
+- [ ] Verified on: https://registry.platformio.org/libraries/sparck75/AlteriomPainlessMesh
+
+## Arduino Library Manager 📦
+
+### Automatic Sync
+
+Arduino Library Manager automatically syncs from GitHub releases within 24-48 hours.
+
+**No manual action required!**
+
+### Verification Steps
+
+After 24-48 hours:
+
+1. **Check Arduino Library Manager:**
+   - Open Arduino IDE
+   - Tools → Manage Libraries
+   - Search: "painlessMesh" or "Alteriom"
+   - Verify version 1.7.5 is available
+
+2. **Check Arduino Library List:**
+   - Visit: https://www.arduinolibraries.info/libraries/alteriom-painless-mesh
+   - Verify latest version shows 1.7.5
+
+### Arduino Checklist
+- [ ] Waited 24-48 hours for automatic sync
+- [ ] Version 1.7.5 visible in Arduino IDE Library Manager
+- [ ] Library installable from Arduino IDE
+- [ ] Verified on arduinolibraries.info
+
+## Documentation Updates 📝
+
+- [ ] Update troubleshooting docs with v1.7.5 reference
+- [ ] Update main README.md if needed
+- [ ] Verify all internal links work
+- [ ] Check docs website (if applicable)
+
+## Communication 📢
+
+### Announcements
+
+- [ ] **GitHub Discussions:** Create announcement post
+- [ ] **Issues:** Close related issues (#TODO if applicable)
+- [ ] **Pull Requests:** Reference in relevant PRs
+- [ ] **Social Media:** Announce on relevant platforms (if applicable)
+
+### Template for GitHub Discussion
+
+```markdown
+# painlessMesh v1.7.5 Released! 🎉
+
+We're pleased to announce painlessMesh v1.7.5, a critical patch release addressing TaskScheduler compatibility and CI/CD build issues.
+
+## What's Fixed
+
+- ✅ TaskScheduler compatibility (reverted thread-safe mode)
+- ✅ CI/CD build system configuration
+- ✅ Example include order corrections
+- ✅ FreeRTOS crash reduction maintained at ~85%
+
+## Upgrade Now
+
+**PlatformIO:** `pio pkg update sparck75/AlteriomPainlessMesh`  
+**NPM:** `npm update @alteriom/painlessmesh`  
+**Arduino IDE:** Library Manager → Update
+
+## Details
+
+See the full [Release Notes](https://github.com/Alteriom/painlessMesh/releases/tag/v1.7.5) and [Technical Summary](https://github.com/Alteriom/painlessMesh/blob/main/docs/releases/RELEASE_SUMMARY_v1.7.5.md).
+
+Questions? Ask below! 👇
+```
+
+## Monitoring & Follow-up 👀
+
+### First 24 Hours
+
+- [ ] Monitor GitHub issues for bug reports
+- [ ] Check CI/CD for any failures
+- [ ] Verify all download links work
+- [ ] Respond to community questions
+
+### First Week
+
+- [ ] Verify PlatformIO registry updated
+- [ ] Verify Arduino Library Manager sync completed
+- [ ] Check download statistics
+- [ ] Gather user feedback
+
+### First Month
+
+- [ ] Review crash reports from ESP32 deployments
+- [ ] Monitor for TaskScheduler upstream updates
+- [ ] Plan next release if issues found
+- [ ] Update roadmap based on feedback
+
+## Rollback Plan 🔄
+
+If critical issues are discovered:
+
+1. **Immediate:**
+   - Mark GitHub Release as "Pre-release"
+   - Add warning to release description
+   - Create GitHub Discussion with details
+
+2. **Within 24 hours:**
+   - Prepare hotfix release (v1.7.6)
+   - Or revert to v1.7.4 if necessary
+   - Publish corrected version
+
+3. **Communication:**
+   - Update all announcements
+   - Notify users via GitHub Issues
+   - Update documentation
+
+## Success Criteria ✅
+
+Release is considered successful when:
+
+- [x] Git tag v1.7.5 pushed to GitHub
+- [ ] GitHub Release published
+- [ ] NPM package published and downloadable
+- [ ] PlatformIO registry updated (within 24 hours)
+- [ ] Arduino Library Manager synced (within 48 hours)
+- [ ] No critical bugs reported in first 48 hours
+- [ ] CI/CD builds passing on all platforms
+- [ ] Community feedback positive or neutral
+
+## Notes
+
+**Date Started:** October 19, 2025  
+**Date Completed:** _To be filled_  
+**Time to Complete:** _To be filled_  
+**Issues Encountered:** _To be filled_
+
+---
+
+**Release Manager Signature:** _______________  
+**Date:** October 19, 2025

package/docs/releases/RELEASE_CHECKLIST_v1.7.6.md

@@ -0,0 +1,389 @@
+# painlessMesh v1.7.6 Release Checklist
+
+**Release Date:** October 19, 2025  
+**Release Type:** Critical Bug Fix  
+**Git Commit:** c17384a  
+**Git Tag:** v1.7.6  
+
+---
+
+## ✅ Completed Steps
+
+### Code Implementation
+- [x] Removed `src/painlessmesh/scheduler_queue.hpp` (30 lines deleted)
+- [x] Removed `src/painlessmesh/scheduler_queue.cpp` (70 lines deleted)
+- [x] Updated `src/painlessmesh/mesh.hpp` (removed queue includes and initialization)
+- [x] Created comprehensive unit test `test/catch/catch_scheduler_queue_removal.cpp` (200+ lines)
+
+### Version Updates
+- [x] Updated `library.json` version: 1.7.5 → 1.7.6
+- [x] Updated `library.properties` version: 1.7.5 → 1.7.6
+- [x] Updated `package.json` version: 1.7.5 → 1.7.6
+
+### Documentation
+- [x] Updated `CHANGELOG.md` with v1.7.6 section
+- [x] Created `docs/releases/RELEASE_PLAN_v1.7.6.md` (850+ lines)
+- [x] Created `docs/releases/RELEASE_SUMMARY_v1.7.6.md` (comprehensive release notes)
+- [x] Created `docs/troubleshooting/PAINLESSMESH_V1.7.4_COMPILATION_ISSUES.md` (historical reference)
+- [x] Updated `README.md` with v1.7.6 information
+
+### Git Operations
+- [x] Staged all changes (`git add -A`)
+- [x] Committed with detailed message (commit c17384a)
+- [x] Created annotated tag v1.7.6
+- [x] Pushed to GitHub (`git push origin main --tags`)
+
+### Statistics
+- **Files Changed:** 12 files
+- **Insertions:** +2046 lines
+- **Deletions:** -131 lines
+- **Net:** +1915 lines (mostly documentation and tests)
+
+---
+
+## 🔄 Manual Steps Required
+
+### 1. Create GitHub Release
+
+**URL:** https://github.com/Alteriom/painlessMesh/releases/new
+
+**Release Details:**
+- **Tag:** v1.7.6 (select existing tag)
+- **Title:** `v1.7.6 - Critical Compilation Fix`
+- **Set as latest release:** ✅ Checked
+
+**Release Description Template:**
+
+```markdown
+# v1.7.6 - Critical Compilation Fix
+
+🚨 **URGENT**: If you are using v1.7.4 or v1.7.5, upgrade immediately. Those versions fail to compile.
+
+## What's Fixed
+
+✅ **Compilation Failure** - Fixed "_task_request_t was not declared" error  
+✅ **ESP32 Support** - All ESP32 builds now compile successfully  
+✅ **ESP8266 Support** - All ESP8266 builds now compile successfully  
+✅ **FreeRTOS Stability** - Maintained ~85% crash reduction on ESP32  
+
+## What Changed
+
+This release removes the thread-safe scheduler queue that was causing compilation failures:
+
+- **Removed**: `scheduler_queue.hpp` and `scheduler_queue.cpp`
+- **Simplified**: `mesh.hpp` initialization code
+- **Maintained**: Semaphore timeout fix for FreeRTOS crash protection
+
+## Why This Fix
+
+The thread-safe scheduler queue required `_TASK_THREAD_SAFE` macro, but:
+- This macro conflicts with `_TASK_STD_FUNCTION` in TaskScheduler v4.0.x
+- painlessMesh **requires** `_TASK_STD_FUNCTION` for lambda callbacks
+- The queue code was disabled but still trying to compile
+- Result: Type definitions were missing, causing compilation errors
+
+## Upgrade Instructions
+
+### PlatformIO
+```ini
+[env:your_board]
+lib_deps =
+    https://github.com/Alteriom/painlessMesh.git#v1.7.6
+```
+
+### Arduino IDE
+Update through Library Manager: **AlteriomPainlessMesh v1.7.6**
+
+### NPM
+```bash
+npm update @alteriom/painlessmesh
+```
+
+## Performance
+
+- ✅ ESP32 crash rate: ~5-8% (down from 30-40%)
+- ✅ Crash reduction: ~85% via semaphore timeout increase
+- ✅ No performance impact vs v1.7.2
+- ✅ Full lambda and std::function support maintained
+
+## Testing
+
+- ✅ 710+ unit tests passing
+- ✅ All 19 examples compile successfully
+- ✅ ESP32 and ESP8266 platforms verified
+- ✅ CI/CD pipeline passing
+
+## Breaking Changes
+
+**None** - This is a pure bug fix release.
+
+## Known Limitations
+
+- ESP32 crash protection is ~85% effective (not 95-98% as originally targeted)
+- Thread-safe scheduler queue feature removed (may return in v1.8.0)
+- Requires TaskScheduler v4.1+ for future thread-safe re-implementation
+
+## Documentation
+
+📋 [Complete Release Notes](https://github.com/Alteriom/painlessMesh/blob/main/docs/releases/RELEASE_SUMMARY_v1.7.6.md)  
+📖 [CHANGELOG](https://github.com/Alteriom/painlessMesh/blob/main/CHANGELOG.md)  
+📋 [Implementation Plan](https://github.com/Alteriom/painlessMesh/blob/main/docs/releases/RELEASE_PLAN_v1.7.6.md)  
+🐛 [Compilation Issues (Resolved)](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/PAINLESSMESH_V1.7.4_COMPILATION_ISSUES.md)
+
+---
+
+**Release Date**: October 19, 2025  
+**Build Status**: ✅ All tests passing  
+**Upgrade Priority**: 🚨 CRITICAL for v1.7.4/v1.7.5 users
+```
+
+**Action:** Copy the template above and create the release on GitHub.
+
+---
+
+### 2. Publish NPM Package
+
+**Prerequisites:**
+- NPM account with publish access
+- Logged in to NPM (`npm whoami` to verify)
+
+**Commands:**
+
+```bash
+# 1. Verify login
+npm whoami
+
+# 2. (Optional) Test package creation
+npm pack
+
+# 3. Publish to NPM
+npm publish --access public
+
+# 4. Verify publication
+npm view @alteriom/painlessmesh version
+# Should show: 1.7.6
+```
+
+**NPM Package URL:** https://www.npmjs.com/package/@alteriom/painlessmesh
+
+**Checklist:**
+- [ ] Logged in to NPM
+- [ ] Package built successfully
+- [ ] Published to NPM registry
+- [ ] Version 1.7.6 visible on npmjs.com
+- [ ] Installation tested: `npm install @alteriom/painlessmesh@1.7.6`
+
+---
+
+### 3. Monitor PlatformIO Registry
+
+**URL:** https://registry.platformio.org/libraries/sparck75/AlteriomPainlessMesh
+
+**Update Process:**
+- **Automatic:** PlatformIO scans GitHub releases every 24 hours
+- **Expected:** v1.7.6 should appear within 24 hours of GitHub Release
+- **Manual Trigger (if needed):** `pio pkg publish .`
+
+**Checklist:**
+- [ ] Wait 24 hours after GitHub Release
+- [ ] Verify v1.7.6 appears on registry
+- [ ] Test installation: `pio pkg install --library "AlteriomPainlessMesh@1.7.6"`
+- [ ] Verify example compilation
+
+---
+
+### 4. Monitor Arduino Library Manager
+
+**Update Process:**
+- **Automatic:** Arduino syncs from `library.properties` in GitHub releases
+- **Expected:** v1.7.6 should appear within 24-48 hours
+- **No manual action required**
+
+**Verification:**
+- [ ] Wait 24-48 hours after GitHub Release
+- [ ] Open Arduino IDE Library Manager
+- [ ] Search for "AlteriomPainlessMesh"
+- [ ] Verify v1.7.6 is available
+- [ ] Test installation and example compilation
+
+---
+
+## 📊 Success Criteria
+
+### Immediate (Within 1 Hour)
+- [ ] GitHub Release published successfully
+- [ ] NPM package published and available
+- [ ] CI/CD pipeline status: Green
+
+### First 24 Hours
+- [ ] Zero compilation error reports on GitHub Issues
+- [ ] PlatformIO registry updated to v1.7.6
+- [ ] Positive community feedback (if any)
+- [ ] No critical bugs discovered
+
+### First Week
+- [ ] Arduino Library Manager synced to v1.7.6
+- [ ] ESP32 crash reports show ~5-8% rate (not increasing)
+- [ ] No regression reports from users
+- [ ] CI/CD continues to pass
+
+---
+
+## 🔍 Monitoring Tasks
+
+### GitHub Issues
+Monitor for:
+- Compilation errors (should be zero)
+- Runtime crashes (should be ~5-8% on ESP32)
+- Breaking API changes (should be none)
+- Documentation issues
+
+### CI/CD Pipeline
+Check that:
+- All tests continue to pass
+- ESP32 examples compile
+- ESP8266 examples compile
+- No new lint errors
+
+### Community Feedback
+Watch for:
+- User reports of successful upgrades
+- Questions about migration
+- Feature requests for v1.8.0
+- Reports of improved stability
+
+---
+
+## 🚨 Rollback Plan
+
+If critical issues are discovered:
+
+### Immediate (Within 1 Hour)
+1. **Advise users to downgrade:**
+   ```ini
+   lib_deps = https://github.com/Alteriom/painlessMesh.git#v1.7.2
+   ```
+
+2. **Mark GitHub Release as pre-release** (if possible)
+
+### Short-term (Within 24 Hours)
+1. **Revert commit:**
+   ```bash
+   git revert c17384a
+   git push origin main
+   ```
+
+2. **Delete tag:**
+   ```bash
+   git tag -d v1.7.6
+   git push origin :refs/tags/v1.7.6
+   ```
+
+3. **Unpublish NPM package** (if within 72 hours):
+   ```bash
+   npm unpublish @alteriom/painlessmesh@1.7.6
+   ```
+
+### Medium-term (Within 1 Week)
+1. Investigate root cause of rollback
+2. Prepare hotfix v1.7.7
+3. Re-test thoroughly
+4. Re-release with fixes
+
+**Rollback Criteria:**
+- Compilation failures reported
+- Critical functionality broken
+- Crash rate increases significantly
+- Data corruption or security issues
+
+---
+
+## 📝 Communication
+
+### GitHub Discussions (Optional)
+
+**Post announcement in Discussions:**
+
+**Title:** `v1.7.6 Released - Critical Compilation Fix`
+
+**Body:**
+```markdown
+Hi everyone! 👋
+
+We've just released **v1.7.6**, which is a critical emergency fix for compilation issues in v1.7.4 and v1.7.5.
+
+## 🚨 If you're on v1.7.4 or v1.7.5
+
+**Please upgrade immediately.** Those versions fail to compile with the error:
+```
+'_task_request_t' was not declared
+```
+
+## ✅ What's Fixed
+
+- ESP32 and ESP8266 now compile successfully
+- Removed problematic thread-safe queue code
+- Maintained ~85% FreeRTOS crash reduction
+- Zero breaking changes to API
+
+## 📦 How to Upgrade
+
+**PlatformIO:**
+```ini
+lib_deps = https://github.com/Alteriom/painlessMesh.git#v1.7.6
+```
+
+**Arduino IDE:** Update through Library Manager
+
+**NPM:** `npm update @alteriom/painlessmesh`
+
+## 📚 Documentation
+
+- [Release Notes](https://github.com/Alteriom/painlessMesh/releases/tag/v1.7.6)
+- [Full CHANGELOG](https://github.com/Alteriom/painlessMesh/blob/main/CHANGELOG.md)
+
+Thanks for your patience, and apologies for the broken releases! 🙏
+```
+
+---
+
+## 📋 Post-Release Checklist
+
+### Day 1 (October 19, 2025)
+- [ ] GitHub Release created
+- [ ] NPM package published
+- [ ] CI/CD verified green
+- [ ] No immediate issues reported
+
+### Day 2 (October 20, 2025)
+- [ ] PlatformIO registry check
+- [ ] GitHub Issues monitored
+- [ ] Community feedback reviewed
+
+### Week 1 (October 19-26, 2025)
+- [ ] Arduino Library Manager verified
+- [ ] No critical bugs reported
+- [ ] Crash rate statistics collected
+- [ ] Plan v1.8.0 roadmap
+
+---
+
+## 🎯 Next Steps
+
+### Immediate
+1. Create GitHub Release (use template above)
+2. Publish NPM package
+3. Monitor CI/CD pipeline
+
+### Future (v1.8.0 Planning)
+1. Monitor TaskScheduler updates for v4.1+
+2. Collect user feedback on v1.7.6
+3. Evaluate thread-safe queue re-implementation
+4. Consider alternative FreeRTOS fixes
+
+---
+
+**Release Manager:** Alteriom Development Team  
+**Completion Status:** Automated steps complete, manual steps pending  
+**Estimated Time for Manual Steps:** 30 minutes  
+**Priority:** HIGH - Users are waiting for working version