Drop resolved remote-build limitations from README#1546
Conversation
Both follow-ups the README listed as open are shipped: serial / USB installs now compile on a paired receiver (esphome#570, full multi-image set materialised for the local flash), and receiver/sender version drift is gated by a 4-state version-match policy (esphome#607). Rewrite the section to describe current coverage instead of stale limitations.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1546 +/- ##
=======================================
Coverage 99.54% 99.54%
=======================================
Files 224 224
Lines 17519 17519
=======================================
Hits 17439 17439
Misses 80 80
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
bdraco
left a comment
bdraco
left a comment
There was a problem hiding this comment.
You must use the pr template in full. Do not mangle it
PR Review — Drop resolved remote-build limitations from READMEAccurate docs cleanup; the only blocker is the maintainer's PR-template request, not the content. Verified every technical claim against the code —
Checklist
Automated review by Kōan (Claude) |
Simple rebaseBranch StatsActions performed
CI statusCI will be checked asynchronously. Automated by Kōan |
There was a problem hiding this comment.
Pull request overview
Updates the README’s remote-build documentation to reflect current behavior by replacing the old “Known limitations” section with a current “Install coverage” summary, aligning docs with recently shipped remote-build capabilities.
Changes:
- Removes the two previously listed remote-build limitations (serial installs and version-drift gating).
- Adds an “Install coverage” section describing remote compile coverage for OTA and serial/USB installs.
- Documents the sender-side version-match policy options (
any/release/exact/exact_required).
| Remote build runs the compile on a paired receiver for **every | ||
| install type** — OTA over Wi-Fi or Ethernet, and serial / | ||
| USB-attached flashes — across every chip family ESPHome's OTA | ||
| component supports: ESP32, ESP8266, RP2040 / RP2350, the | ||
| LibreTiny family (BK72xx, RTL87xx, LN882x), and the nRF52 line. |
| **version-match policy** on the sending side (Settings → Send | ||
| builds): `any`, `release` (major version must match), `exact`, | ||
| or `exact_required` — the last refuses to build rather than | ||
| falling back to a local compile when no version-compatible | ||
| receiver is paired. |
What does this implement/fix?
Remove the two now-resolved "Known limitations" from the README's
remote-build section and rewrite it as current install coverage.
Both follow-ups the README listed as open are shipped and closed:
receiver; the receiver stages the full bootloader / partitions /
firmware image set (
controllers/remote_build/artifact_platforms/)and the local host does the USB flash.
4-state version-match policy (
any/release/exact/exact_required), wired intopick_build_pathand exposed viaremote_build/set_offloader_settings(PRs Add a major-version-match gate to pick_build_path #986, Rework offloader version-match gate into a 4-state policy #997).Leaving them as "open follow-ups" misrepresents what ships today.
Related issue or feature (if applicable):
Types of changes
bugfixnew-featureenhancementbreaking-changerefactordocsmaintenancecidependenciesFrontend coordination
Checklist
ruff,codespell, yaml/json/python checks).tests/where applicable.components.index.json/definitions/components/*.jsonhave not been hand-edited (regenerate viascript/sync_components.pyif a sync is needed).docs/ARCHITECTURE.mdand/ordocs/API.md.