@alteriom/painlessmesh 1.8.14 → 1.9.0

package/docs/releases/RELEASE_CHECKLIST_v1.7.4.md

@@ -1,253 +0,0 @@
-# v1.7.4 Release Checklist
-
-**Release Date:** October 19, 2025  
-**Release Commit:** 7cd66ac  
-**Git Tag:** v1.7.4
-
-## Pre-Release Tasks ✅
-
-- [x] Update version in `library.json` to 1.7.4
-- [x] Update version in `library.properties` to 1.7.4
-- [x] Update version in `package.json` to 1.7.4
-- [x] Update `CHANGELOG.md` with v1.7.4 entry
-- [x] Create `docs/releases/PATCH_v1.7.4.md` release notes
-- [x] Create release commit with "release:" prefix
-- [x] Create annotated git tag `v1.7.4`
-- [x] Push commit to main branch
-- [x] Push tag to trigger workflows
-
-## Automated Workflows
-
-### GitHub Actions (Monitor: https://github.com/Alteriom/painlessMesh/actions)
-
-- [ ] **Desktop Build Workflow** - Should pass
-- [ ] **PlatformIO Build Workflow** - Should pass (ESP32 & ESP8266)
-- [ ] **NPM Publish Workflow** - Should trigger on tag push
-- [ ] **GitHub Release Creation** - Auto-created from tag
-
-### Registry Updates
-
-- [ ] **GitHub Release** - Check created with correct notes
-- [ ] **NPM Registry** - Verify `@alteriom/painlessmesh@1.7.4` published
-- [ ] **PlatformIO Registry** - Should sync from GitHub release (may take hours)
-- [ ] **Arduino Library Manager** - Indexing may take 24-48 hours
-
-## Post-Release Verification
-
-### Package Availability
-
-Check each registry is updated:
-
-```bash
-# NPM
-npm view @alteriom/painlessmesh version
-# Expected: 1.7.4
-
-# PlatformIO
-pio pkg search "AlteriomPainlessMesh" --page 1
-# Expected: v1.7.4 in results
-
-# Arduino (check manually)
-# https://www.arduino.cc/reference/en/libraries/alteriompainlessmesh/
-```
-
-### Installation Testing
-
-- [ ] Test PlatformIO installation: `pio pkg install --library "alteriom/AlteriomPainlessMesh@^1.7.4"`
-- [ ] Test NPM installation: `npm install @alteriom/painlessmesh@^1.7.4`
-- [ ] Test Arduino IDE installation (once indexed)
-- [ ] Verify example sketches compile with new version
-
-### Documentation
-
-- [ ] Verify GitHub release page created
-- [ ] Check release notes display correctly
-- [ ] Ensure all links in release notes work
-- [ ] Update any external documentation sites (if applicable)
-
-## Hardware Testing (Recommended)
-
-### ESP32 Testing
-
-- [ ] **Gateway Node**
-  - Flash with v1.7.4
-  - Enable debug output
-  - Monitor serial for clean startup
-
-- [ ] **Sensor Node (Single)**
-  - Connect to gateway
-  - Verify no FreeRTOS assertion
-  - Check heap stability
-
-- [ ] **Multiple Sensor Nodes**
-  - Connect 5+ nodes simultaneously
-  - Monitor for crashes
-  - Verify all connections successful
-
-- [ ] **Sustained Operation**
-  - Run for 1+ hour
-  - Monitor heap every 30 seconds
-  - Check for memory leaks
-
-### ESP8266 Testing (Regression Check)
-
-- [ ] Verify builds successfully
-- [ ] Test basic mesh connectivity
-- [ ] Confirm no unexpected behavior changes
-
-### Monitoring Script
-
-Add to test sketches:
-
-```cpp
-mesh.onNewConnection([](uint32_t nodeId) {
-    Serial.printf("✅ Connection: Node=%u Heap=%d Stack=%d\n", 
-                  nodeId, ESP.getFreeHeap(), 
-                  uxTaskGetStackHighWaterMark(NULL));
-});
-
-mesh.onDroppedConnection([](uint32_t nodeId) {
-    Serial.printf("❌ Dropped: Node=%u Heap=%d\n", 
-                  nodeId, ESP.getFreeHeap());
-});
-
-// In loop() or scheduled task
-void checkHealth() {
-    Serial.printf("Health: Nodes=%d Heap=%d Uptime=%lu\n",
-                  mesh.getNodeList().size(),
-                  ESP.getFreeHeap(),
-                  millis() / 1000);
-}
-```
-
-## Community Communication
-
-### Announcements
-
-- [ ] **GitHub Discussions** - Post release announcement
-- [ ] **Discord/Slack** - Share release highlights
-- [ ] **Forum Posts** - Update relevant threads about FreeRTOS crashes
-- [ ] **README.md** - Ensure latest version badge updated (if applicable)
-
-### Social Media (Optional)
-
-- [ ] Twitter/X announcement
-- [ ] LinkedIn post
-- [ ] Reddit (r/esp32, r/arduino if relevant)
-
-### Sample Announcement
-
-```
-🎉 painlessMesh v1.7.4 Released!
-
-Critical stability release for ESP32 users experiencing mesh connection crashes.
-
-✅ FreeRTOS assertion fix - 95% crash reduction
-✅ Complete ArduinoJson v7 compatibility
-✅ Comprehensive troubleshooting documentation
-
-Upgrade: https://github.com/Alteriom/painlessMesh/releases/tag/v1.7.4
-
-#ESP32 #IoT #MeshNetwork #Arduino #PlatformIO
-```
-
-## Issue Tracking
-
-### Close Related Issues
-
-Search for issues related to:
-- FreeRTOS assertion failures
-- ESP32 connection crashes
-- ArduinoJson v7 compatibility
-- `vTaskPriorityDisinheritAfterTimeout`
-
-Comment on each with:
-```
-Fixed in v1.7.4. Please upgrade and retest. If issue persists, reopen with:
-- Library version (confirm 1.7.4)
-- Full serial output
-- ESP32 board type
-- Arduino/PlatformIO version
-```
-
-### Monitor for New Issues
-
-Watch for:
-- Installation problems
-- New crashes or regressions
-- Documentation errors
-- Build failures
-
-## Rollback Plan
-
-If critical issues discovered:
-
-### Minor Issues
-- Document in known issues
-- Plan for v1.7.5 hotfix
-
-### Major Issues
-- Create `v1.7.3-lts` branch
-- Publish advisory
-- Prepare v1.7.5 with revert
-
-### Emergency Rollback
-```bash
-git tag -d v1.7.4
-git push origin :refs/tags/v1.7.4
-git revert 7cd66ac
-git commit -m "Revert v1.7.4 due to [critical issue]"
-git tag -a v1.7.3-hotfix -m "Emergency hotfix"
-git push origin main --tags
-```
-
-## Next Steps (Future Development)
-
-### v1.7.5 (If Needed)
-- Hotfixes only
-- Release within 1-2 weeks if issues found
-
-### v1.8.0 (Next Feature Release)
-- [ ] P1: Hop count calculation and tracking
-- [ ] P1: Routing table management improvements
-- [ ] P2: Deprecated type cleanup
-- [ ] P2: OTA semantics improvements
-- [ ] Target: 4-6 weeks
-
-### Long-term Roadmap
-- Documentation website improvements
-- Performance benchmarking suite
-- Advanced mesh topology features
-- Enhanced security options
-
-## Notes
-
-### Success Criteria
-
-This release is considered successful if:
-- ✅ All CI/CD workflows pass
-- ✅ Packages published to all registries
-- ✅ No critical bugs reported within 72 hours
-- ✅ ESP32 crash reports decrease significantly
-- ✅ Positive community feedback
-
-### Metrics to Track
-
-- Download counts per registry
-- Issue reports related to v1.7.4
-- Community feedback sentiment
-- Crash rate reports from users
-
-## Completed Checklist
-
-**Pre-Release:** 8/8 ✅  
-**Automated Workflows:** 0/4 ⏳ (in progress)  
-**Post-Release Verification:** 0/7 ⏳ (pending)  
-**Hardware Testing:** 0/7 ⏳ (recommended)  
-**Community Communication:** 0/4 ⏳ (pending)
-
----
-
-**Last Updated:** October 19, 2025  
-**Release Manager:** Alteriom Team  
-**Status:** 🚀 Released - Monitoring Workflows

package/docs/releases/RELEASE_CHECKLIST_v1.7.5.md

@@ -1,315 +0,0 @@
-# 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