mat/homeassistant-comwatt
Watch
1
0
Fork
You've already forked homeassistant-comwatt
 0
Code Issues 36 Pull requests 1 Projects Releases Packages Activity Actions

🔥 chore: drop info.md, HACS 2.0+ renders the README #76

Merged
mat merged 1 commit from remove-info-md into main 2026-08-24 10:05:35 +00:00
Conversation 0 Commits 1 Files changed 1 -26
mat commented 2026-08-24 09:59:34 +00:00
Owner
Copy link

Follow-up to the #54 doc discussion (PR #75).

What

Deletes info.md.

Why

  • HACS stopped rendering info.md in 2.0.0: "info.md files are no longer rendered. Instead, the README is used." The integration requires Home Assistant 2025.6+ (hacs.json), so every user is on a HACS recent enough to show the README instead.
  • The file was a stale duplicate of the README with no reader left.
  • A symlink (info.md -> README.md) was considered and rejected: raw.githubusercontent.com does not follow symlinks, and the HACS installer materializes them as plain files containing the target path (hacs/integration#1115).

The portable lint/test/type-check jobs run on this PR; HACS validation runs on the GitHub mirror once merged.

Follow-up to the #54 doc discussion (PR #75). ## What Deletes `info.md`. ## Why - HACS stopped rendering `info.md` in [2.0.0](https://github.com/hacs/integration/releases/tag/2.0.0): _"info.md files are no longer rendered. Instead, the README is used."_ The integration requires Home Assistant 2025.6+ (`hacs.json`), so every user is on a HACS recent enough to show the README instead. - The file was a stale duplicate of the README with no reader left. - A symlink (`info.md -> README.md`) was considered and rejected: `raw.githubusercontent.com` does not follow symlinks, and the HACS installer materializes them as plain files containing the target path ([hacs/integration#1115](https://github.com/hacs/integration/issues/1115)). The portable lint/test/type-check jobs run on this PR; HACS validation runs on the GitHub mirror once merged.
🔥 chore: drop info.md, HACS 2.0+ renders the README
All checks were successful
Validate / lint-ruff (push) Successful in 7s
Details
Validate / test-pytest (push) Successful in 3m10s
Details
Validate / type-check-mypy (push) Successful in 3m13s
Details
Validate / lint-ruff (pull_request) Successful in 7s
Details
Validate / test-pytest (pull_request) Successful in 3m12s
Details
Validate / type-check-mypy (pull_request) Successful in 3m13s
Details
62b9d949d8 
info.md has not been read by HACS since 2.0.0 ('info.md files are no
longer rendered. Instead, the README is used') and this integration
requires Home Assistant 2025.6+, so every user is on a recent HACS.
The file was a stale duplicate of the README with no reader left.

A symlink was considered and rejected: raw.githubusercontent.com does
not follow symlinks and the HACS installer materializes them as plain
files containing the target path (hacs/integration#1115).
mat changed title from WIP: 🔥 chore: drop info.md, HACS 2.0+ renders the README to 🔥 chore: drop info.md, HACS 2.0+ renders the README 2026-08-24 10:05:31 +00:00
mat merged commit 037be4e28f into main 2026-08-24 10:05:35 +00:00
mat deleted branch remove-info-md 2026-08-24 10:05:35 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
v1.0 · bloquant
À corriger absolument avant la release v1.0

  
v1.0 · majeur
Fortement recommandé avant la v1.0

  
v1.0 · mineur
Polish / robustesse, non bloquant

No labels
v1.0 · bloquant
v1.0 · majeur
v1.0 · mineur
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
mat/homeassistant-comwatt!76
No description provided.