hacs-publish

name	hacs-publish
description	Getting a custom integration installable — the HACS custom-repository route, the requirements the HACS action checks, submitting to the HACS default list, and the route to upstreaming into Home Assistant core. Use when the HACS CI job fails, when asked how users install this, or when considering listing it publicly.

Publishing

How people install it today

As a custom repository in HACS: HACS → ⋮ → Custom repositories → the repo URL, category Integration. The my.home-assistant.io badge in the README does this in two clicks, which is why it belongs at the top.

HACS then offers each GitHub release as a version. There is no separate publish step — see .claude/skills/cut-release.

What the HACS action checks

The hacs CI job fails on repository metadata as often as on code. It requires:

• A repository description, and topics — at minimum home-assistant. Set both:

  gh repo edit --description "…" \
               --add-topic home-assistant --add-topic hacs \
               --add-topic home-assistant-custom-component
  

• hacs.json at the root with name, and content_in_root: false for the custom_components/<domain>/ layout.
• Exactly one directory under custom_components/, containing a valid manifest.json.
• A README.md.
• At least one published release (for the default-list check; the plain action tolerates none).

homeassistant in hacs.json is a floor: HACS hides the integration from anyone running older. Set it to the oldest version actually tested, not the newest available — and keep it in step with the pin in .