Skip to content

chore(release): 4.5.1 + document MeshCore TCP transport#3032

Merged
Yeraze merged 1 commit into
mainfrom
release/4.5.1
May 15, 2026
Merged

chore(release): 4.5.1 + document MeshCore TCP transport#3032
Yeraze merged 1 commit into
mainfrom
release/4.5.1

Conversation

@Yeraze
Copy link
Copy Markdown
Owner

@Yeraze Yeraze commented May 15, 2026

Summary

What changed in the docs

The MeshCore feature page already mentioned TCP in passing, but didn't explain how to use it. New content in docs/features/meshcore.md:

  • A dedicated TCP Transport subsection under "Adding a MeshCore Source"
  • Host / port form-field table (default port is 4403)
  • Three common deployment patterns: native TCP firmware, ser2net, esp-link
  • Container-networking tip — TCP sources resolve from inside the container, so use a LAN IP or host.docker.internal, not localhost/127.0.0.1
  • Companion-only warning (Repeaters are still USB-only)
  • Updated Troubleshooting section to split USB vs TCP failure cases

Test plan

  • tsc --noEmit passes (no type regressions)
  • Version is consistent across all five files (grep -E '"?version"?' … returns 4.5.1 everywhere)
  • Docs change is markdown-only; new anchor #tcp-transport is referenced from step 4 of the add-source list
  • VitePress build (run on CI) — confirms the new section renders and the anchor link resolves

System tests (tests/system-tests.sh) were skipped — this PR is version-bump + docs only and does not touch any runtime code paths.

🤖 Generated with Claude Code

Bump version to 4.5.1 across all five files (package.json, package-lock.json,
helm/meshmonitor/Chart.yaml, desktop/package.json, desktop/src-tauri/tauri.conf.json).

Document the MeshCore TCP transport that landed in #3027: a new "TCP Transport"
subsection under "Adding a MeshCore Source" covering the host/port form fields
(default port 4403), common ways to put a Companion on TCP (native TCP firmware,
ser2net, esp-link), container-networking guidance (use a LAN IP or
host.docker.internal, not localhost), and a Companion-only warning. Updated the
troubleshooting section to split USB vs TCP guidance.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 15, 2026

Claude finished @Yeraze's task —— View job


PR Review: 4.5.1 Release + MeshCore TCP Documentation

I've analyzed this pull request for code quality, potential issues, performance, security, and test coverage.

Review Tasks

  • Analyze version consistency across all 5 files
  • Review documentation changes for accuracy and clarity
  • Check for potential bugs or security issues
  • Assess performance considerations
  • Evaluate test coverage adequacy

🔍 Version Consistency Analysis

✅ PASS - All version references are correctly updated to 4.5.1:

File Version Field Status
package.json "version": "4.5.1"
package-lock.json "version": "4.5.1" (lines 3 & 9)
helm/meshmonitor/Chart.yaml version: 4.5.1 & appVersion: "4.5.1"
desktop/package.json "version": "4.5.1"
desktop/src-tauri/tauri.conf.json "version": "4.5.1"

📚 Documentation Review

The MeshCore TCP transport documentation is comprehensive and well-structured:

Strengths:

  • Clear subsection organization with proper anchor linking (#tcp-transport)
  • Practical deployment patterns (native TCP firmware, ser2net, esp-link)
  • Helpful networking guidance for Docker containers (host.docker.internal vs localhost)
  • Proper field documentation with defaults (port 4403)
  • Device-specific limitations clearly noted (Companion-only for TCP)
  • Updated troubleshooting section separating USB vs TCP failure modes

Security & Safety:

  • No hardcoded credentials or sensitive data
  • Proper warnings about container networking considerations
  • Clear device compatibility limitations

🔒 Security Assessment

✅ No security concerns identified:

  • Changes are version bumps and documentation only
  • No code execution paths modified
  • No new attack surfaces introduced
  • Documentation follows safe practices (no credential exposure)

⚡ Performance Considerations

✅ No performance impact:

  • Version changes are metadata only
  • Documentation is static content (no runtime impact)
  • No database schema changes or migrations
  • No new dependencies introduced

🧪 Test Coverage Assessment

Mixed - Appropriate for the change scope:

✅ Adequate for this PR:

  • Author correctly notes this is "version-bump + docs only"
  • TypeScript compilation check mentioned in test plan
  • System tests appropriately skipped (no runtime changes)

📝 Notes:

  • Version consistency could be automated with tooling to prevent future drift
  • VitePress build verification is delegated to CI (appropriate)

📋 Code Quality

✅ High quality release preparation:

Positives:

  • Follows established version bump patterns from CLAUDE.md
  • Comprehensive documentation update matching the feature capability
  • Proper git commit practices
  • Clear PR description with specific test plan

Minor observations:

  • All changes align with documented MeshMonitor conventions
  • Documentation writing is clear and technically accurate
  • Proper use of VitePress markdown features (warnings, tips, tables)

🎯 Overall Assessment

This is a well-executed release preparation PR that:

  • ✅ Maintains version consistency across all required files
  • ✅ Documents new TCP transport functionality comprehensively
  • ✅ Introduces no security, performance, or stability risks
  • ✅ Appropriately scopes testing for documentation-only changes
  • ✅ Follows project conventions and best practices

Recommendation: APPROVE - This PR is ready for merge. The version bump is consistent, the documentation is comprehensive and helpful, and the changes pose no risk to the system.


@Yeraze Yeraze merged commit 4e808d4 into main May 15, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant