@alteriom/painlessmesh 1.6.1 → 1.7.2

package/RELEASE_GUIDE.md

@@ -1,419 +1,505 @@
-# painlessMesh Release Guide
-
-This document provides comprehensive instructions for releasing new versions of the Alteriom painlessMesh library across all distribution channels.
-
-## 🚀 Quick Release Process
-
-### Standard Release (Recommended)
-
-```bash
-# 1. Update version using the bump script
-./scripts/bump-version.sh patch  # or minor, major
-
-# 2. Update CHANGELOG.md with your changes
-# Add your changes under the new version section
-
-# 3. Commit and trigger release
-git add library.properties library.json package.json CHANGELOG.md
-git commit -m "release: v1.6.1"
-git push origin main
-```
-
-**That's it!** GitHub Actions will automatically handle:
-- ✅ Comprehensive testing across platforms
-- ✅ Git tag creation and GitHub release
-- ✅ NPM publishing (public + GitHub Packages)
-- ✅ GitHub Wiki synchronization
-- ✅ Arduino Library Manager package preparation
-- ✅ Release notes generation from changelog
-
-## 📋 Distribution Channels
-
-### Automatic (Zero Manual Work Required)
-1. **GitHub Releases** - Created with changelog and downloadable packages
-2. **NPM Public Registry** - Published to https://www.npmjs.com/package/@alteriom/painlessmesh
-3. **GitHub Packages** - Published to GitHub's NPM registry (@alteriom/painlessmesh)
-4. **PlatformIO Registry** - Automatically indexed from GitHub releases
-5. **GitHub Wiki** - Documentation synchronized from repository
-
-### Semi-Automatic (One-Time Manual Submission)
-6. **Arduino Library Manager** - Submit once, then automatically indexed
-
-## 🎯 Detailed Process
-
-### Version Management
-
-**File Consistency**: All three files must have matching versions:
-
-```properties
-# library.properties
-version=1.6.1
-```
-
-```json
-// library.json  
-{
-  "version": "1.6.1"
-}
-```
-
-```json
-// package.json
-{
-  "version": "1.6.1"
-}
-```
-
-**Semantic Versioning**: Follow [semver.org](https://semver.org/):
-- **MAJOR**: Breaking changes (e.g., 1.6.0 → 2.0.0)
-- **MINOR**: New features, backward compatible (e.g., 1.6.0 → 1.7.0)  
-- **PATCH**: Bug fixes, backward compatible (e.g., 1.6.0 → 1.6.1)
-
-### Automation Triggers
-
-The release workflow triggers on commits to `main` that:
-1. Modify `library.properties`, `library.json`, `package.json`, or `CHANGELOG.md`
-2. Have a commit message starting with `release:`
-
-### What Gets Automated
-
-#### Testing Pipeline
-- **Desktop builds**: gcc & clang with strict warnings
-- **Arduino CLI**: ESP32 & ESP8266 compilation
-- **PlatformIO**: Cross-platform build validation
-- **Code quality**: Formatting and lint checks
-
-#### Release Artifacts
-- **Git tag**: `v1.6.1` format
-- **GitHub Release**: With changelog excerpt
-- **Library package**: `painlessMesh-v1.6.1.zip`
-- **Documentation**: Auto-deployed to GitHub Pages
-
-#### NPM Publishing
-- **Public NPM**: Available to anyone via `npm install @alteriom/painlessmesh`
-- **GitHub Packages**: Scoped package for authenticated users
-- **Version consistency**: Verified across all package files
-
-#### Wiki Updates
-- **Home Page**: Generated from README.md
-- **API Reference**: Auto-generated documentation
-- **Examples**: Links to repository examples
-- **Installation Guide**: Multi-platform instructions
-
-## 📦 NPM Publishing Details
-
-### Dual Publishing Strategy
-
-Each release publishes to **two NPM registries**:
-
-1. **Public NPM** (npmjs.com)
-   - Package: `@alteriom/painlessmesh`
-   - Installation: `npm install @alteriom/painlessmesh`
-   - No authentication required
-
-2. **GitHub Packages** (npm.pkg.github.com)
-   - Package: `@alteriom/painlessmesh`
-   - Installation: Requires `.npmrc` configuration
-   - Authentication required for installation
-
-### NPM Package Contents
-
-The NPM package includes:
-- `src/` - Complete library source code
-- `examples/` - All Arduino examples
-- `docs/` - Documentation files
-- `library.properties` - Arduino metadata
-- `library.json` - PlatformIO metadata
-- Core documentation files (README, LICENSE, CHANGELOG)
-
-Excluded from NPM package:
-- Development files (`.github/`, `test/`, `scripts/`)
-- Build artifacts (`bin/`, `build/`)
-- IDE files and OS-specific files
-
-## 🛠️ Arduino Library Manager
-
-### One-Time Submission Process
-
-After your first release, submit to Arduino Library Manager:
-
-1. **Go to**: https://github.com/arduino/library-registry
-2. **Create issue** with this template:
-
-```
-Title: Add painlessMesh library
-
-Repository URL: https://github.com/Alteriom/painlessMesh
-Release tag: v1.6.1
-Library name: painlessMesh
-Version: 1.6.1
-
-This is the Alteriom fork of the painlessMesh library with enhanced 
-CI/CD, automated releases, and improved Arduino Library Manager compatibility.
-Includes SensorPackage, CommandPackage, and StatusPackage extensions.
-```
-
-3. **Monitor** the issue for Arduino team approval
-4. **Future releases** are automatically indexed
-
-### Arduino Library Compliance
-
-The library meets all Arduino Library Manager requirements:
-- ✅ Correct directory structure
-- ✅ Valid `library.properties` file
-- ✅ Source files in `src/` directory
-- ✅ Examples compile successfully
-- ✅ Consistent version numbering
-- ✅ Open source license (LGPL-3.0)
-
-## 📚 GitHub Wiki Management
-
-### Automatic Synchronization
-
-Wiki pages are automatically updated on each release:
-
-- **Home** - From README.md
-- **Release-Guide** - From RELEASE_GUIDE.md  
-- **Changelog** - From CHANGELOG.md
-- **API-Reference** - Generated documentation
-- **Examples** - Auto-generated from examples directory
-- **Installation** - Multi-platform installation guide
-- **Contributing** - From CONTRIBUTING.md
-
-### Manual Wiki Updates
-
-If you need to update the wiki manually:
-
-```bash
-# Clone wiki repository
-git clone https://github.com/Alteriom/painlessMesh.wiki.git
-
-# Edit markdown files directly
-# Commit and push changes
-```
-
-Note: Manual changes may be overwritten by automatic synchronization.
-
-## 🔧 Scripts Reference
-
-### `./scripts/bump-version.sh`
-Updates version in all library files with consistency checks.
-
-**Usage:**
-```bash
-./scripts/bump-version.sh patch        # Increment patch version
-./scripts/bump-version.sh minor        # Increment minor version  
-./scripts/bump-version.sh major        # Increment major version
-./scripts/bump-version.sh patch 1.6.2  # Set specific version
-```
-
-### `./scripts/validate-release.sh`
-Comprehensive pre-release validation.
-
-**Checks:**
-- Version consistency between all files
-- Changelog entries for current version
-- Git working tree status
-- Tag existence validation
-- Dependency declarations
-- Build file presence
-- Quick compilation test
-
-## 🚨 Troubleshooting
-
-### Common Issues
-
-**Version Mismatch Error**
-```bash
-# Fix version inconsistencies
-./scripts/bump-version.sh patch 1.6.2  # Force set version
-```
-
-**Missing Changelog Entry**
-```bash
-# Add changelog entry for current version
-vim CHANGELOG.md
-# Add section: ## [1.6.2] - YYYY-MM-DD
-```
-
-**Build Failures**
-```bash
-# Test locally before release
-npm run build
-npm run test
-```
-
-**NPM Token Invalid**
-```bash
-# Verify NPM authentication
-npm whoami
-# If not logged in: npm login
-```
-
-**GitHub Packages Authentication**
-```bash
-# Check if GITHUB_TOKEN has packages:write permission
-# Repository Settings → Actions → General → Permissions
-```
-
-**Wiki Update Failure**
-```bash
-# Wiki may need manual initialization
-# Go to: https://github.com/Alteriom/painlessMesh/wiki
-# Create any page to initialize, then re-run release
-```
-
-### Manual Override
-
-If automation fails, you can manually perform any step:
-
-```bash
-# Manual NPM publish
-npm publish --access public
-
-# Manual GitHub release  
-gh release create v1.6.2 --title "painlessMesh v1.6.2" --notes-file CHANGELOG.md
-
-# Manual tag creation
-git tag v1.6.2
-git push origin v1.6.2
-```
-
-## 🔍 Validation Commands
-
-### Pre-Release Checks
-```bash
-# Comprehensive validation
-./scripts/validate-release.sh
-
-# Version consistency check
-./scripts/bump-version.sh --verify || echo "Use proper arguments"
-
-# NPM package validation
-npm run validate-library
-
-# Build test
-npm run build && npm run test
-```
-
-### Post-Release Verification
-```bash
-# Check NPM publication
-npm view @alteriom/painlessmesh
-
-# Check GitHub Packages
-npm view @alteriom/painlessmesh --registry=https://npm.pkg.github.com
-
-# Verify GitHub release
-gh release view
-
-# Check wiki update
-curl -s https://github.com/Alteriom/painlessMesh/wiki | grep -q "v1.6.2"
-```
-
-## 🎉 Success Indicators
-
-### Successful Release Shows:
-- ✅ GitHub release created with changelog
-- ✅ Git tag pushed to repository  
-- ✅ NPM package published (check npmjs.com)
-- ✅ GitHub Packages updated
-- ✅ Wiki pages synchronized
-- ✅ All GitHub Actions workflows completed successfully
-
-### Distribution Verification:
-```bash
-# Public NPM
-npm view @alteriom/painlessmesh
-
-# GitHub Packages
-npm view @alteriom/painlessmesh --registry=https://npm.pkg.github.com
-
-# PlatformIO (updated within 24 hours)
-# Check: https://registry.platformio.org/libraries/alteriom/painlessMesh
-
-# Arduino Library Manager (after manual submission)
-# Search in Arduino IDE Library Manager
-```
-
-## 🌟 Advanced Topics
-
-### Custom Release Notes
-
-To customize release notes beyond the changelog:
-
-1. Edit the generated `release_notes.txt` in the workflow
-2. Or create a custom release notes file in `.github/release-template.md`
-
-### Environment-Specific Releases
-
-For testing releases:
-
-```bash
-# Use pre-release tags
-git tag v1.6.2-beta
-git push origin v1.6.2-beta
-
-# This creates a pre-release without full publication
-```
-
-### Rollback Procedure
-
-If a release has issues:
-
-```bash
-# Delete remote tag
-git push origin :refs/tags/v1.6.2
-
-# Delete local tag  
-git tag -d v1.6.2
-
-# Delete GitHub release
-gh release delete v1.6.2
-
-# Unpublish NPM package (contact npm support)
-# GitHub Packages: Delete from package settings
-```
-
-## 📊 Release Metrics
-
-Monitor your releases:
-- **GitHub**: https://github.com/Alteriom/painlessMesh/releases
-- **NPM**: https://www.npmjs.com/package/@alteriom/painlessmesh
-- **PlatformIO**: https://registry.platformio.org/libraries/alteriom/painlessMesh
-- **Wiki**: https://github.com/Alteriom/painlessMesh/wiki
-
-## 🤝 Security & Permissions
-
-### Required GitHub Secrets
-- `GITHUB_TOKEN`: Automatically provided by GitHub Actions
-- `NPM_TOKEN`: Required for NPM publishing (add in repository secrets)
-
-### Repository Settings
-- **Actions**: Enabled with write permissions
-- **Packages**: Enabled for GitHub Packages publication
-- **Wiki**: Enabled for documentation deployment
-- **Releases**: Public releases enabled
-
----
-
-## Quick Reference
-
-**Release a patch version:**
-```bash
-./scripts/bump-version.sh patch
-# Edit CHANGELOG.md
-git add . && git commit -m "release: v1.6.2" && git push
-```
-
-**Check release status:**
-```bash
-./scripts/validate-release.sh
-```
-
-**Monitor release:**
-- GitHub Actions: https://github.com/Alteriom/painlessMesh/actions
-- Releases: https://github.com/Alteriom/painlessMesh/releases
-- Documentation: https://github.com/Alteriom/painlessMesh/wiki
-
+# painlessMesh Release Guide
+
+This document provides comprehensive instructions for releasing new versions of the Alteriom painlessMesh library across all distribution channels.
+
+## 🚀 Quick Release Process
+
+### Standard Release (Recommended)
+
+```bash
+# 1. Update version using the bump script
+./scripts/bump-version.sh patch  # or minor, major
+
+# 2. Update CHANGELOG.md with your changes
+# Add your changes under the new version section
+
+# 3. Commit and trigger release
+git add library.properties library.json package.json CHANGELOG.md
+git commit -m "release: v1.6.1"
+git push origin main
+```
+
+**That's it!** GitHub Actions will automatically handle:
+- ✅ Comprehensive testing across platforms
+- ✅ Git tag creation and GitHub release
+- ✅ NPM publishing (public + GitHub Packages)
+- ✅ **PlatformIO Library Registry publishing**
+- ✅ GitHub Wiki synchronization
+- ✅ Arduino Library Manager package preparation
+- ✅ Release notes generation from changelog
+
+## 📋 Distribution Channels
+
+### Automatic (Zero Manual Work Required)
+
+1. **GitHub Releases** - Created with changelog and downloadable packages
+2. **NPM Public Registry** - Published to <https://www.npmjs.com/package/@alteriom/painlessmesh>
+3. **GitHub Packages** - Published to GitHub's NPM registry (@alteriom/painlessmesh)
+4. **PlatformIO Registry** - Automatically published via GitHub Actions workflow
+5. **GitHub Wiki** - Documentation synchronized from repository
+
+### Semi-Automatic (One-Time Manual Submission)
+
+1. **Arduino Library Manager** - Submit once, then automatically indexed
+
+## 🎯 Detailed Process
+
+### Version Management
+
+**File Consistency**: All three files must have matching versions:
+
+```properties
+# library.properties
+version=1.6.1
+```
+
+```json
+// library.json  
+{
+  "version": "1.6.1"
+}
+```
+
+```json
+// package.json
+{
+  "version": "1.6.1"
+}
+```
+
+**Semantic Versioning**: Follow [semver.org](https://semver.org/):
+- **MAJOR**: Breaking changes (e.g., 1.6.0 → 2.0.0)
+- **MINOR**: New features, backward compatible (e.g., 1.6.0 → 1.7.0)  
+- **PATCH**: Bug fixes, backward compatible (e.g., 1.6.0 → 1.6.1)
+
+### Automation Triggers
+
+The release workflow triggers on commits to `main` that:
+1. Modify `library.properties`, `library.json`, `package.json`, or `CHANGELOG.md`
+2. Have a commit message starting with `release:`
+
+### What Gets Automated
+
+#### Testing Pipeline
+- **Desktop builds**: gcc & clang with strict warnings
+- **Arduino CLI**: ESP32 & ESP8266 compilation
+- **PlatformIO**: Cross-platform build validation
+- **Code quality**: Formatting and lint checks
+
+#### Release Artifacts
+- **Git tag**: `v1.6.1` format
+- **GitHub Release**: With changelog excerpt
+- **Library package**: `painlessMesh-v1.6.1.zip`
+- **Documentation**: Auto-deployed to GitHub Pages
+
+#### NPM Publishing
+- **Public NPM**: Available to anyone via `npm install @alteriom/painlessmesh`
+- **GitHub Packages**: Scoped package for authenticated users
+- **Version consistency**: Verified across all package files
+
+#### Wiki Updates
+- **Home Page**: Generated from README.md
+- **API Reference**: Auto-generated documentation
+- **Examples**: Links to repository examples
+- **Installation Guide**: Multi-platform instructions
+
+## 📦 NPM Publishing Details
+
+### Dual Publishing Strategy
+
+Each release publishes to **two NPM registries**:
+
+1. **Public NPM** (npmjs.com)
+   - Package: `@alteriom/painlessmesh`
+   - Installation: `npm install @alteriom/painlessmesh`
+   - No authentication required
+
+2. **GitHub Packages** (npm.pkg.github.com)
+   - Package: `@alteriom/painlessmesh`
+   - Installation: Requires `.npmrc` configuration
+   - Authentication required for installation
+
+### NPM Package Contents
+
+The NPM package includes:
+- `src/` - Complete library source code
+- `examples/` - All Arduino examples
+- `docs/` - Documentation files
+- `library.properties` - Arduino metadata
+- `library.json` - PlatformIO metadata
+- Core documentation files (README, LICENSE, CHANGELOG)
+
+Excluded from NPM package:
+
+- Development files (`.github/`, `test/`, `scripts/`)
+- Build artifacts (`bin/`, `build/`)
+- IDE files and OS-specific files
+
+## 🔧 PlatformIO Library Registry
+
+### Automatic Publishing
+
+Each release triggers the **PlatformIO Library Publishing** workflow:
+
+1. **Validation**: Comprehensive library.json validation
+2. **Dependencies**: Verification that all dependencies exist in PlatformIO Registry
+3. **Authentication**: Uses `PLATFORMIO_AUTH_TOKEN` secret
+4. **Publication**: Direct publishing via PlatformIO CLI
+5. **Verification**: Post-publication registry verification
+
+### Setup Requirements
+
+#### One-Time Setup: PlatformIO Account & Token
+
+1. **Create Account**: <https://platformio.org/account/register>
+2. **Generate Token**: <https://platformio.org/account/token>
+3. **Add Secret**: Repository Settings → Secrets → `PLATFORMIO_AUTH_TOKEN`
+
+#### Automatic Workflow Trigger
+
+The PlatformIO workflow automatically triggers on:
+
+- New GitHub releases (tags)
+- Manual workflow dispatch for testing
+
+### PlatformIO Package Contents
+
+Published package includes:
+
+- Complete source code (`src/`)
+- All examples (`examples/`)
+- PlatformIO metadata (`library.json`)
+- Arduino compatibility (`library.properties`)
+- Documentation files
+
+### Installation
+
+Users can install via PlatformIO:
+
+```ini
+# platformio.ini
+[env:esp32dev]
+platform = espressif32
+board = esp32dev
+framework = arduino
+lib_deps = alteriom/AlteriomPainlessMesh@^1.6.1
+```
+
+Or via CLI:
+
+```bash
+pio pkg install --library "alteriom/AlteriomPainlessMesh@^1.6.1"
+```
+
+### Manual Publication (Fallback)
+
+If automatic publishing fails:
+
+```bash
+# Install PlatformIO CLI
+pip install platformio
+
+# Authenticate
+pio account token --set YOUR_TOKEN
+
+# Publish from repository root
+pio pkg publish .
+```
+
+### Monitoring
+
+- **Registry**: <https://registry.platformio.org/libraries>
+- **Search**: <https://registry.platformio.org/search?q=AlteriomPainlessMesh>
+- **Workflow**: GitHub Actions → PlatformIO Library Publishing
+
+## 🛠️ Arduino Library Manager
+
+### One-Time Submission Process
+
+After your first release, submit to Arduino Library Manager:
+
+1. **Go to**: https://github.com/arduino/library-registry
+2. **Create issue** with this template:
+
+```
+Title: Add painlessMesh library
+
+Repository URL: https://github.com/Alteriom/painlessMesh
+Release tag: v1.6.1
+Library name: painlessMesh
+Version: 1.6.1
+
+This is the Alteriom fork of the painlessMesh library with enhanced 
+CI/CD, automated releases, and improved Arduino Library Manager compatibility.
+Includes SensorPackage, CommandPackage, and StatusPackage extensions.
+```
+
+3. **Monitor** the issue for Arduino team approval
+4. **Future releases** are automatically indexed
+
+### Arduino Library Compliance
+
+The library meets all Arduino Library Manager requirements:
+- ✅ Correct directory structure
+- ✅ Valid `library.properties` file
+- ✅ Source files in `src/` directory
+- ✅ Examples compile successfully
+- ✅ Consistent version numbering
+- ✅ Open source license (LGPL-3.0)
+
+## 📚 GitHub Wiki Management
+
+### Automatic Synchronization
+
+Wiki pages are automatically updated on each release:
+
+- **Home** - From README.md
+- **Release-Guide** - From RELEASE_GUIDE.md  
+- **Changelog** - From CHANGELOG.md
+- **API-Reference** - Generated documentation
+- **Examples** - Auto-generated from examples directory
+- **Installation** - Multi-platform installation guide
+- **Contributing** - From CONTRIBUTING.md
+
+### Manual Wiki Updates
+
+If you need to update the wiki manually:
+
+```bash
+# Clone wiki repository
+git clone https://github.com/Alteriom/painlessMesh.wiki.git
+
+# Edit markdown files directly
+# Commit and push changes
+```
+
+Note: Manual changes may be overwritten by automatic synchronization.
+
+## 🔧 Scripts Reference
+
+### `./scripts/bump-version.sh`
+Updates version in all library files with consistency checks.
+
+**Usage:**
+```bash
+./scripts/bump-version.sh patch        # Increment patch version
+./scripts/bump-version.sh minor        # Increment minor version  
+./scripts/bump-version.sh major        # Increment major version
+./scripts/bump-version.sh patch 1.6.2  # Set specific version
+```
+
+### `./scripts/validate-release.sh`
+Comprehensive pre-release validation.
+
+**Checks:**
+- Version consistency between all files
+- Changelog entries for current version
+- Git working tree status
+- Tag existence validation
+- Dependency declarations
+- Build file presence
+- Quick compilation test
+
+## 🚨 Troubleshooting
+
+### Common Issues
+
+**Version Mismatch Error**
+```bash
+# Fix version inconsistencies
+./scripts/bump-version.sh patch 1.6.2  # Force set version
+```
+
+**Missing Changelog Entry**
+```bash
+# Add changelog entry for current version
+vim CHANGELOG.md
+# Add section: ## [1.6.2] - YYYY-MM-DD
+```
+
+**Build Failures**
+```bash
+# Test locally before release
+npm run build
+npm run test
+```
+
+**NPM Token Invalid**
+```bash
+# Verify NPM authentication
+npm whoami
+# If not logged in: npm login
+```
+
+**GitHub Packages Authentication**
+```bash
+# Check if GITHUB_TOKEN has packages:write permission
+# Repository Settings → Actions → General → Permissions
+```
+
+**Wiki Update Failure**
+```bash
+# Wiki may need manual initialization
+# Go to: https://github.com/Alteriom/painlessMesh/wiki
+# Create any page to initialize, then re-run release
+```
+
+### Manual Override
+
+If automation fails, you can manually perform any step:
+
+```bash
+# Manual NPM publish
+npm publish --access public
+
+# Manual GitHub release  
+gh release create v1.6.2 --title "painlessMesh v1.6.2" --notes-file CHANGELOG.md
+
+# Manual tag creation
+git tag v1.6.2
+git push origin v1.6.2
+```
+
+## 🔍 Validation Commands
+
+### Pre-Release Checks
+```bash
+# Comprehensive validation
+./scripts/validate-release.sh
+
+# Version consistency check
+./scripts/bump-version.sh --verify || echo "Use proper arguments"
+
+# NPM package validation
+npm run validate-library
+
+# Build test
+npm run build && npm run test
+```
+
+### Post-Release Verification
+```bash
+# Check NPM publication
+npm view @alteriom/painlessmesh
+
+# Check GitHub Packages
+npm view @alteriom/painlessmesh --registry=https://npm.pkg.github.com
+
+# Check PlatformIO Registry
+pio pkg search "AlteriomPainlessMesh"
+
+# Verify GitHub release
+gh release view
+
+# Check wiki update
+curl -s https://github.com/Alteriom/painlessMesh/wiki | grep -q "v1.6.2"
+```
+
+## 🎉 Success Indicators
+
+### Successful Release Shows:
+- ✅ GitHub release created with changelog
+- ✅ Git tag pushed to repository  
+- ✅ NPM package published (check npmjs.com)
+- ✅ GitHub Packages updated
+- ✅ Wiki pages synchronized
+- ✅ All GitHub Actions workflows completed successfully
+
+### Distribution Verification:
+```bash
+# Public NPM
+npm view @alteriom/painlessmesh
+
+# GitHub Packages
+npm view @alteriom/painlessmesh --registry=https://npm.pkg.github.com
+
+# PlatformIO (updated within minutes via GitHub Actions)
+# Check: https://registry.platformio.org/libraries/alteriom/AlteriomPainlessMesh
+
+# Arduino Library Manager (after manual submission)
+# Search in Arduino IDE Library Manager
+```
+
+## 🌟 Advanced Topics
+
+### Custom Release Notes
+
+To customize release notes beyond the changelog:
+
+1. Edit the generated `release_notes.txt` in the workflow
+2. Or create a custom release notes file in `.github/release-template.md`
+
+### Environment-Specific Releases
+
+For testing releases:
+
+```bash
+# Use pre-release tags
+git tag v1.6.2-beta
+git push origin v1.6.2-beta
+
+# This creates a pre-release without full publication
+```
+
+### Rollback Procedure
+
+If a release has issues:
+
+```bash
+# Delete remote tag
+git push origin :refs/tags/v1.6.2
+
+# Delete local tag  
+git tag -d v1.6.2
+
+# Delete GitHub release
+gh release delete v1.6.2
+
+# Unpublish NPM package (contact npm support)
+# GitHub Packages: Delete from package settings
+```
+
+## 📊 Release Metrics
+
+Monitor your releases:
+- **GitHub**: https://github.com/Alteriom/painlessMesh/releases
+- **NPM**: https://www.npmjs.com/package/@alteriom/painlessmesh
+- **PlatformIO**: https://registry.platformio.org/libraries/alteriom/painlessMesh
+- **Wiki**: https://github.com/Alteriom/painlessMesh/wiki
+
+## 🤝 Security & Permissions
+
+### Required GitHub Secrets
+
+- `GITHUB_TOKEN`: Automatically provided by GitHub Actions
+- `NPM_TOKEN`: Required for NPM publishing (add in repository secrets)
+- `PLATFORMIO_AUTH_TOKEN`: Required for PlatformIO Library Registry publishing
+
+### Repository Settings
+- **Actions**: Enabled with write permissions
+- **Packages**: Enabled for GitHub Packages publication
+- **Wiki**: Enabled for documentation deployment
+- **Releases**: Public releases enabled
+
+---
+
+## Quick Reference
+
+**Release a patch version:**
+```bash
+./scripts/bump-version.sh patch
+# Edit CHANGELOG.md
+git add . && git commit -m "release: v1.6.2" && git push
+```
+
+**Check release status:**
+```bash
+./scripts/validate-release.sh
+```
+
+**Monitor release:**
+- GitHub Actions: https://github.com/Alteriom/painlessMesh/actions
+- Releases: https://github.com/Alteriom/painlessMesh/releases
+- Documentation: https://github.com/Alteriom/painlessMesh/wiki
+
 For questions or issues with the release process, create an issue with the `ci/cd` label.