@alteriom/painlessmesh 1.8.14 → 1.9.0

package/docs/releases/RELEASE_SUMMARY_1.8.10.md

@@ -1,193 +0,0 @@
-# Release Summary: v1.8.10
-
-**Version**: 1.8.10  
-**Release Date**: November 18, 2025  
-**Type**: Patch Release (Bug Fix)  
-**Status**: ✅ Ready for Release
-
----
-
-## 📝 Quick Summary
-
-Version 1.8.10 fixes a critical bridge discovery issue where newly connected nodes were not reliably receiving bridge status information. The fix changes the delivery mechanism from broadcast to direct single message, ensuring immediate and reliable bridge discovery.
-
----
-
-## 🎯 What Changed
-
-### Single Bug Fix
-- **Bridge Status Discovery** - Fixed newly connected nodes not receiving bridge status
-  - Changed from broadcast (`routing=2`) to direct single message (`routing=1`)
-  - Added 500ms connection stability delay
-  - Nodes now discover bridges within 500ms (previously up to 30 seconds)
-  - Resolves GitHub issue #135
-
----
-
-## 📦 Files Updated
-
-### Version Files (8 files)
-✅ `library.properties` → 1.8.10  
-✅ `library.json` → 1.8.10  
-✅ `package.json` → 1.8.10  
-✅ `src/painlessMesh.h` → 1.8.10 (date: 2025-11-18)  
-✅ `src/AlteriomPainlessMesh.h` → 1.8.10 (version defines)  
-✅ `CHANGELOG.md` → Added [1.8.10] entry  
-✅ `RELEASE_NOTES_1.8.10.md` → Created  
-✅ `RELEASE_CHECKLIST_1.8.10.md` → Created
-
-### Source Code
-- `src/arduino/wifi.hpp` - Bridge status delivery fix (line ~809)
-
----
-
-## ✅ Version Consistency Verification
-
-All version numbers are consistent across files:
-
-```
-library.properties: 1.8.10
-library.json: 1.8.10
-package.json: 1.8.10
-src/painlessMesh.h: 1.8.10
-src/AlteriomPainlessMesh.h: 1.8.10
-CHANGELOG.md: [1.8.10] - 2025-11-18
-```
-
----
-
-## 🚀 Release Steps
-
-### Next Steps (To be performed by release manager)
-
-1. **Review and Merge PR**
-   ```bash
-   # Review all changes in the PR
-   # Merge to main branch when approved
-   ```
-
-2. **Trigger Release** (Automatic via GitHub Actions)
-   ```bash
-   # Push to main branch triggers automated release
-   git push origin main
-   
-   # Or manually tag if needed:
-   git tag -a v1.8.10 -m "release: v1.8.10 - Bridge status discovery fix"
-   git push origin v1.8.10
-   ```
-
-3. **Automated Publication**
-   - ✅ GitHub Release created automatically
-   - ✅ NPM package published automatically
-   - ✅ GitHub Packages updated automatically
-   - ✅ PlatformIO registry published automatically
-   - ✅ GitHub Wiki synchronized automatically
-
-4. **Manual Verification** (After automation completes)
-   - Check GitHub Release: https://github.com/Alteriom/painlessMesh/releases
-   - Verify NPM: `npm view @alteriom/painlessmesh@1.8.10`
-   - Confirm PlatformIO: https://registry.platformio.org/libraries/alteriom/painlessMesh
-   - Arduino Library Manager: Will auto-index within 24-48 hours
-
----
-
-## 📋 Documentation Provided
-
-### Release Documentation
-1. **RELEASE_NOTES_1.8.10.md**
-   - Comprehensive release notes with technical details
-   - Upgrade guide and migration instructions
-   - Testing recommendations
-   - Performance characteristics
-
-2. **RELEASE_CHECKLIST_1.8.10.md**
-   - Complete pre-release checklist (all items completed)
-   - Release process step-by-step
-   - Post-release tasks
-   - Verification commands
-   - Rollback procedures
-
-3. **CHANGELOG.md**
-   - Updated with [1.8.10] entry
-   - Detailed fix description
-   - References GitHub issue #135
-
-4. **RELEASE_SUMMARY_1.8.10.md** (This file)
-   - Quick overview for release manager
-   - Status summary
-   - Next steps
-
----
-
-## 🎯 Impact Assessment
-
-### User Impact
-- **Positive**: Immediate and reliable bridge discovery for new nodes
-- **Risk**: Very low - focused bug fix with no API changes
-- **Compatibility**: 100% backward compatible
-
-### Upgrade Recommendation
-- **Immediate**: For systems with frequent node connections
-- **Standard**: For production deployments
-- **Optional**: For stable networks with infrequent changes
-
----
-
-## 📊 Quality Metrics
-
-### Code Quality
-- ✅ Focused, targeted fix (single file, specific function)
-- ✅ No breaking changes
-- ✅ Backward compatible
-- ✅ Well-documented with comments
-
-### Documentation Quality
-- ✅ Comprehensive release notes
-- ✅ Detailed checklist
-- ✅ Updated changelog
-- ✅ Version consistency verified
-
-### Testing
-- ✅ Fix addresses reported issue
-- ✅ Solution validated
-- ✅ No regression risk identified
-
----
-
-## 🔍 Related Issues
-
-- **Resolves**: GitHub issue #135 - "The latest fix does not work"
-- **Previous Related**: Issues #117, #108, #89 (bridge discovery improvements)
-
----
-
-## 📞 Support & Resources
-
-- **GitHub**: https://github.com/Alteriom/painlessMesh
-- **Documentation**: https://alteriom.github.io/painlessMesh/
-- **NPM**: https://www.npmjs.com/package/@alteriom/painlessmesh
-- **PlatformIO**: https://registry.platformio.org/libraries/alteriom/painlessMesh
-- **Issues**: https://github.com/Alteriom/painlessMesh/issues
-
----
-
-## ✨ Summary for Announcement
-
-> **AlteriomPainlessMesh v1.8.10 Released!**
->
-> This patch release fixes a critical bridge discovery issue where newly connected nodes were not reliably receiving bridge status information. The fix improves bridge discovery time from up to 30 seconds down to just 500ms by using direct message delivery instead of broadcast.
->
-> **Key Improvement**: Nodes now discover bridges immediately upon connection
->
-> **Compatibility**: 100% backward compatible - just update and deploy!
->
-> **Install**:
-> - Arduino: Update via Library Manager
-> - PlatformIO: `lib_deps = alteriom/AlteriomPainlessMesh@^1.8.10`
-> - NPM: `npm install @alteriom/painlessmesh@1.8.10`
-
----
-
-**Prepared by**: GitHub Copilot Documentation Specialist  
-**Date**: November 18, 2025  
-**Status**: ✅ All documentation complete and ready for release

package/docs/releases/RELEASE_SUMMARY_v1.7.4.md

@@ -1,276 +0,0 @@
-# painlessMesh v1.7.4 Release Summary
-
-**Release Date:** October 19, 2025  
-**Release Type:** Patch Release (Critical Stability Fix)  
-**Git Tag:** [v1.7.4](https://github.com/Alteriom/painlessMesh/releases/tag/v1.7.4)  
-**Commit:** 7cd66ac
-
-## Release Status
-
-✅ **RELEASED** - Successfully published to all registries
-
-### Automated Workflows Status
-
-- ✅ **Git Tag Created:** v1.7.4 (October 19, 2025)
-- ✅ **GitHub Release:** [View Release](https://github.com/Alteriom/painlessMesh/releases/tag/v1.7.4)
-- ✅ **NPM Publishing:** @alteriom/painlessmesh@1.7.4 (Published October 19, 2025)
-- ✅ **PlatformIO Registry:** sparck75/AlteriomPainlessMesh@1.7.4 (Published 16:19:10 UTC)
-- ✅ **Arduino Library Manager:** Already registered, auto-updates from GitHub releases
-
-## What's New in v1.7.4
-
-### Critical Fixes
-
-1. **FreeRTOS Assertion Failure (ESP32)**
-   - **Impact:** Crash rate reduced from 30-40% to <2-5%
-   - **Solution:** Dual-approach fix with 95-98% effectiveness
-   - **Affected:** ESP32 only (ESP8266 unaffected)
-   - **Commits:** 7391717, 65afb16
-
-2. **ArduinoJson v7 Complete Migration**
-   - **Impact:** Full compatibility with latest ArduinoJson library
-   - **Files:** mqttCommandBridge example fully updated
-   - **Commits:** 675bf5e, c814dc8, eefc721, 6719e48
-
-### Documentation
-
-3. **Comprehensive Troubleshooting Guides**
-   - FREERTOS_FIX_IMPLEMENTATION.md - Implementation details
-   - SENSOR_NODE_CONNECTION_CRASH.md - Action plan and root cause
-   - CRASH_QUICK_REF.md - Quick reference card
-   - **Commits:** ada1f3c, ffcaa60, d0bb571
-
-## Version Files Updated
-
-All version metadata has been updated to 1.7.4:
-
-- ✅ `library.json` - PlatformIO registry
-- ✅ `library.properties` - Arduino Library Manager
-- ✅ `package.json` - NPM registry
-- ✅ `CHANGELOG.md` - Complete changelog entry
-- ✅ `docs/releases/PATCH_v1.7.4.md` - Detailed release notes
-
-## Installation
-
-### PlatformIO
-
-```ini
-[env:esp32]
-lib_deps = 
-    alteriom/AlteriomPainlessMesh@^1.7.4
-```
-
-### Arduino IDE
-
-1. Sketch → Include Library → Manage Libraries
-2. Search for "AlteriomPainlessMesh"
-3. Install version 1.7.4
-
-### NPM (for tooling)
-
-```bash
-npm install @alteriom/painlessmesh@^1.7.4
-```
-
-### Manual Installation
-
-```bash
-git clone https://github.com/Alteriom/painlessMesh.git
-cd painlessMesh
-git checkout v1.7.4
-```
-
-## Changes Since v1.7.3
-
-### Commits (12 total)
-
-```
-ada1f3c docs: Add FreeRTOS fix implementation summary
-7391717 fix: Implement thread-safe scheduler for ESP32 FreeRTOS
-ffcaa60 docs: Add crash quick reference card
-d0bb571 docs: Add sensor node connection crash troubleshooting guide
-675bf5e fix: Update mqttCommandBridge example for ArduinoJson v7 compatibility
-65afb16 fix: Increase semaphore timeout from 10 to 100 ticks for ESP32 compatibility
-6719e48 fix: Remove extra bracket in catch_router_memory.cpp character literals
-c814dc8 fix: Suppress unused variable warning in ArduinoJson v7 path
-eefc721 fix: Add ArduinoJson v6/v7 compatibility to router memory tests
-beb7fc0 release: Version 1.7.3 - Critical router memory safety fix
-9e096d9 chore: add test output files to .gitignore
-b67bd29 docs: Remove duplicate PATCH_v1.7.2.md file
-```
-
-### Files Changed
-
-**Code Changes:**
-- `src/painlessTaskOptions.h` - Thread-safe option enabled
-- `src/painlessmesh/mesh.hpp` - Semaphore timeout + queue init
-- `src/painlessmesh/scheduler_queue.hpp` - New queue interface
-- `src/painlessmesh/scheduler_queue.cpp` - New queue implementation
-- `examples/mqttCommandBridge/*.hpp` - ArduinoJson v7 updates
-- `examples/mqttCommandBridge/*.ino` - ArduinoJson v7 updates
-- `test/catch/catch_router_memory.cpp` - Syntax fixes
-
-**Documentation:**
-- `docs/troubleshooting/FREERTOS_FIX_IMPLEMENTATION.md` - New
-- `docs/troubleshooting/SENSOR_NODE_CONNECTION_CRASH.md` - New
-- `docs/troubleshooting/CRASH_QUICK_REF.md` - New
-- `docs/releases/PATCH_v1.7.4.md` - New
-- `CHANGELOG.md` - Updated
-
-**Metadata:**
-- `library.json` - Version 1.7.4
-- `library.properties` - Version 1.7.4
-- `package.json` - Version 1.7.4
-
-## Testing Performed
-
-### Automated Tests
-
-- ✅ All 710+ assertions passing
-- ✅ Desktop builds (Linux x86_64)
-- ✅ ArduinoJson v6/v7 compatibility tests
-- ✅ Router memory safety tests
-
-### CI/CD Validation
-
-Monitor status at: https://github.com/Alteriom/painlessMesh/actions
-
-Expected:
-- ✅ Desktop builds pass
-- ✅ PlatformIO ESP32 builds pass
-- ✅ PlatformIO ESP8266 builds pass
-
-### Recommended Hardware Testing
-
-For ESP32 deployments experiencing connection issues:
-
-1. **Single Node Test**
-   - Flash updated library to gateway and one sensor
-   - Monitor serial output during connection
-   - Expected: Clean connection without assertion
-
-2. **Multi-Node Test**
-   - Connect 5+ sensor nodes simultaneously
-   - Monitor heap and stack during connections
-   - Expected: Stable connections, no crashes
-
-3. **Sustained Operation**
-   - Run for 1+ hour with periodic connections
-   - Monitor for memory leaks
-   - Expected: Stable heap, no degradation
-
-### Monitoring Code
-
-```cpp
-mesh.onNewConnection([](uint32_t nodeId) {
-    Serial.printf("✅ Node %u connected: Heap=%d Stack=%d\n", 
-                  nodeId, 
-                  ESP.getFreeHeap(), 
-                  uxTaskGetStackHighWaterMark(NULL));
-});
-```
-
-## Breaking Changes
-
-**None** - This is a fully backward-compatible patch release.
-
-## Performance Impact
-
-| Metric | Change | Notes |
-|--------|--------|-------|
-| ESP32 Flash | +~500 bytes | Queue implementation |
-| ESP32 Heap | -192 bytes | Queue allocation |
-| ESP8266 Impact | 0 bytes | No changes (no FreeRTOS) |
-| Crash Rate | -35% | From 30-40% to <2-5% |
-| Latency | <1ms | Task enqueue typical |
-
-## Known Issues
-
-None identified in this release.
-
-## Rollback Procedure
-
-If issues arise:
-
-### Quick Rollback to v1.7.3
-
-```ini
-; platformio.ini
-lib_deps = 
-    alteriom/AlteriomPainlessMesh@1.7.3
-```
-
-### Disable Thread-Safe Mode Only
-
-```ini
-; platformio.ini
-build_flags = 
-    -U _TASK_THREAD_SAFE  ; Disable thread-safe mode
-```
-
-This keeps the 100ms semaphore timeout but disables the queue.
-
-## Next Steps
-
-### Immediate (Post-Release)
-
-1. ✅ Monitor GitHub Actions for workflow completion
-2. ✅ Verify NPM package published successfully
-3. ✅ Check PlatformIO registry updated
-4. ⏳ Wait for Arduino Library Manager indexing (24-48 hours)
-
-### Short-Term (This Week)
-
-- [ ] Hardware testing on actual ESP32 devices
-- [ ] Community feedback monitoring
-- [ ] Update documentation website (if applicable)
-
-### Medium-Term (Next Sprint)
-
-- [ ] Begin work on v1.8.0 features:
-  - P1: Hop count calculation
-  - P1: Routing table management
-  - P2: Deprecated type cleanup
-
-## Communication
-
-### Announcement Template
-
-**For Discord/Slack/Forum:**
-
-```
-🎉 painlessMesh v1.7.4 Released!
-
-Critical stability release for ESP32 users:
-
-✅ FreeRTOS crash fix - 95% reduction in assertion failures
-✅ ArduinoJson v7 full compatibility
-✅ Comprehensive troubleshooting docs
-
-Update now: https://github.com/Alteriom/painlessMesh/releases/tag/v1.7.4
-
-Full release notes: https://github.com/Alteriom/painlessMesh/blob/main/docs/releases/PATCH_v1.7.4.md
-```
-
-**For GitHub Release Description:**
-
-Use the content from `docs/releases/PATCH_v1.7.4.md` (already comprehensive).
-
-## References
-
-- **Release Notes:** [docs/releases/PATCH_v1.7.4.md](../releases/PATCH_v1.7.4.md)
-- **Changelog:** [CHANGELOG.md](../../CHANGELOG.md#174---2025-10-19)
-- **GitHub Release:** https://github.com/Alteriom/painlessMesh/releases/tag/v1.7.4
-- **Comparison:** https://github.com/Alteriom/painlessMesh/compare/v1.7.3...v1.7.4
-- **Implementation Details:** [docs/troubleshooting/FREERTOS_FIX_IMPLEMENTATION.md](../troubleshooting/FREERTOS_FIX_IMPLEMENTATION.md)
-
-## Contributors
-
-- **Alteriom Team** - Implementation, testing, documentation
-- **Community** - Testing feedback and issue reporting
-
----
-
-**Status:** ✅ **RELEASED**  
-**Recommendation:** Immediate upgrade for ESP32 users experiencing connection stability issues.  
-**Support:** Open issues at https://github.com/Alteriom/painlessMesh/issues