Skip to content

Document integration categories validation check #711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ludeeus wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document integration categories validation check #711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff43170
Document the integration categories check
claude Oct 19, 2026
b80a76d
Keep the ignorable checks table alignment
claude Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/docs/publish/action.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ All these checks can be disabled with `with.ignore`. Use a string, and if you ig
| `hacsjson` | [More info](/docs/publish/include.md#check-hacs-manifest) | Checks that hacs.json exists |
| `images` | [More info](/docs/publish/include.md#check-images) | Checks that the info file has images |
| `information` | [More info](/docs/publish/include.md#check-repository) | Checks that the repo has an information file |
| `integration_categories` | [More info](/docs/publish/include.md#check-integration-categories) | Checks that the integration categories are valid |
| `issues` | [More info](/docs/publish/include.md#check-repository) | Checks that issues are enabled |
| `license` | [More info](/docs/publish/include.md#check-license) | Checks that the repository has an OSI license |
| `topics` | [More info](/docs/publish/include.md#check-repository) | Checks that the repository has topics |
Expand Down
6 changes: 6 additions & 0 deletions source/docs/publish/include.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ Custom integrations that override a core integration are not accepted as default

Checks that your integration's manifest is valid. [Learn more](integration.md#manifestjson) or see the [integration manifest documentation](https://developers.home-assistant.io/docs/creating_integration_manifest). Applies only to integrations.

### Check integration categories

_Applies only to integrations._

Checks the optional `categories` key in your integration's `manifest.json`. Each value must be a category from Home Assistant core, like `energy`, or a subcategory, like `energy.ev_charging`. List each category only once, and use at most 3. If your manifest doesn't have `categories`, the check passes with a warning. For the categories you can choose from, see [Integration categories](https://contributors.home-assistant.io/core/integrations/categories/).

### Check hacs-validation

Runs the same validation that HACS itself uses to check your repository.
Expand Down
2 changes: 2 additions & 0 deletions source/docs/publish/integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ In your integration directory you must have a `manifest.json` file, which must a

Check the official Home Assistant [documentation](https://developers.home-assistant.io/docs/creating_integration_manifest) for the values of those keys.

Your `manifest.json` can also define the optional `categories` key. The HACS action checks its values, see [Check integration categories](include.md#check-integration-categories).


### Brand assets

Expand Down
Loading