Skip to content

Mark README status as stable after 1.0 release#1548

Merged
bdraco merged 1 commit into
esphome:mainfrom
esphbot:koan/readme-stable-status
Jun 18, 2026
Merged

Mark README status as stable after 1.0 release#1548
bdraco merged 1 commit into
esphome:mainfrom
esphbot:koan/readme-stable-status

Conversation

@esphbot

@esphbot esphbot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

What does this implement/fix?

Update the README status banner to reflect the 1.0 stable release. The
banner still read "in active development… late beta / early beta… expect
undocumented breaking changes until the project is marked stable." But
1.0.0 shipped on 2026-06-15 and the project is now at 1.0.9 stable — and
the add-on already runs the Device Builder by default as of ESPHome
2026.6.0. The "until stable" framing is stale and undersells the
project's maturity.

Rewrote the > **Status:** line: the project reached its 1.0 release and
ships as the default builder in the official ESPHome add-on (as of
ESPHome 2026.6.0). Kept the issues / project-board / Discord invite
intact. Docs-only change; no code paths touched.

Related issue or feature (if applicable):

  • fixes

Types of changes

  • Bugfix (non-breaking change which fixes an issue) — bugfix
  • New feature (non-breaking change which adds functionality) — new-feature
  • Enhancement to an existing feature — enhancement
  • Breaking change (fix or feature that would cause existing functionality to not work as expected) — breaking-change
  • Refactor (no behaviour change) — refactor
  • Documentation only — docs
  • Maintenance / chore — maintenance
  • CI / workflow change — ci
  • Dependencies bump — dependencies

Frontend coordination

  • No frontend change needed
  • Companion frontend PR: esphome/device-builder-frontend#

Checklist

  • The code change is tested and works locally.
  • Pre-commit hooks pass (ruff, codespell, yaml/json/python checks).
  • Tests have been added or updated under tests/ where applicable.
  • components.index.json / definitions/components/*.json have not been hand-edited (regenerate via script/sync_components.py if a sync is needed).
  • Architecture-level changes are reflected in docs/ARCHITECTURE.md and/or docs/API.md.

@codspeed-hq

codspeed-hq Bot commented Jun 18, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 27 untouched benchmarks


Comparing esphbot:koan/readme-stable-status (46b0084) with main (81cbdf7)

Open in CodSpeed

@codecov

codecov Bot commented Jun 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.54%. Comparing base (81cbdf7) to head (46b0084).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1548   +/-   ##
=======================================
  Coverage   99.54%   99.54%           
=======================================
  Files         224      224           
  Lines       17519    17519           
=======================================
  Hits        17439    17439           
  Misses         80       80           
Flag Coverage Δ
py3.12 99.51% <ø> (ø)
py3.14 99.54% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bdraco bdraco left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Must use the full pr template. Do not mangle it or remove sections

@esphbot

esphbot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

PR Review — Mark README status as stable after 1.0 release

Accurate one-line README maturity update; blocked only by the maintainer's PR-template request, not by the diff.

Strengths:

  • The factual claim is correct and verifiable — 1.0.x is shipping (release tags) and Device Builder runs by default in the ESPHome add-on as of 2026.6.0, matching the prior run's verification.
  • The rewrite preserves the rest of the banner intact: issues link, project-board link, and Discord invite all survive. No collateral edits.
  • Scope matches the description: docs-only, single banner line.

Needs attention:

  • @bdraco requested CHANGES ("Must use the full PR template. Do not mangle it or remove sections") — this is the blocking item. Restore the complete PR template body before merge; the diff itself is fine.
  • CLAUDE.md still describes the project as late/early beta — same staleness, one file over. Consider updating for consistency or tracking as a follow-up (suggestion Add section config API and user preferences #1).
  • The "Tests: failed" and 3840-files/408-commits-behind figures in the quality report reflect a stale branch base, not this change — a rebase onto current main would clean up the comparison and any unrelated CI noise.

🟢 Suggestions

1. CLAUDE.md still carries the stale beta framing (`README.md`, L5-7)

The README banner now reads "stable," but CLAUDE.md ("What this project is") still states: "Base functions are in late beta; remote / offload functions are in early beta. Expect undocumented breaking changes until stable. Targeted to land as an opt-in preview toggle..."

That's the same maturity drift this PR fixes, one file over. After this lands, the two docs disagree on project status.

  • Optional: update the CLAUDE.md paragraph in the same branch so the maturity story is consistent (the project's own convention values keeping docs in sync with reality).
  • If you'd rather keep this PR a one-line README touch, fine — but the inconsistency should be tracked as a follow-up rather than left silently.

Checklist

  • Change matches stated purpose (docs-only banner update)
  • Factual claims verifiable (1.0 release, add-on default)
  • Docs kept internally consistent — suggestion #1
  • No code paths affected

Automated review by Kōan (Claude) HEAD=1eec935 1 min 5s

@github-actions github-actions Bot added the docs Documentation label Jun 18, 2026
@esphbot

esphbot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

Simple rebase

Branch koan/readme-stable-status was rebased onto main — no additional changes were needed.

Stats

1 file changed, 3 insertions(+), 3 deletions(-)
Actions performed
  • Already-solved check: negative (confidence=high, reasoning=No commit on main rewrites the README status banner from beta to stable; recent README change (Drop resolved remote-build limitations from README #1546)
  • Rebased koan/readme-stable-status onto upstream/main
  • Pre-push CI check: previous run #27739953573 failed
  • Pre-push CI fix: no changes needed or Claude found nothing to fix
  • Force-pushed koan/readme-stable-status to origin
  • CI check enqueued in ## CI (async)

CI status

CI will be checked asynchronously.


Automated by Kōan

@esphbot esphbot force-pushed the koan/readme-stable-status branch from 1eec935 to 46b0084 Compare June 18, 2026 06:16
@bdraco bdraco marked this pull request as ready for review June 18, 2026 06:18
Copilot AI review requested due to automatic review settings June 18, 2026 06:18
@bdraco bdraco enabled auto-merge (squash) June 18, 2026 06:19
@bdraco bdraco merged commit 3049402 into esphome:main Jun 18, 2026
17 checks passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project’s README status banner to reflect that ESPHome Device Builder has reached a stable 1.0 release and is now the default builder in the official ESPHome add-on.

Changes:

  • Replaces the “active development / beta / expect breaking changes” status banner text with “stable” 1.0 messaging.
  • Calls out that the dashboard ships as the default builder in the official ESPHome add-on (as of ESPHome 2026.6.0).

Comment thread README.md
Comment on lines +5 to +7
> **Status:** stable. The dashboard reached its 1.0 release and ships
> as the default builder in the official ESPHome add-on (as of ESPHome
> 2026.6.0). Issues
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants