diff --git a/source/docs/publish/action.md b/source/docs/publish/action.md index 2bffbbf4..896d36c0 100644 --- a/source/docs/publish/action.md +++ b/source/docs/publish/action.md @@ -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 | diff --git a/source/docs/publish/include.md b/source/docs/publish/include.md index 81fbea7e..64f6ecf0 100644 --- a/source/docs/publish/include.md +++ b/source/docs/publish/include.md @@ -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. diff --git a/source/docs/publish/integration.md b/source/docs/publish/integration.md index 5942c619..a100f837 100644 --- a/source/docs/publish/integration.md +++ b/source/docs/publish/integration.md @@ -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