Skip to content

Add core domain override check documentation #700

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 1 commit into
base: main
Choose a base branch
from
Open

Add core domain override check documentation #700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 11 additions & 10 deletions source/docs/publish/action.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,17 @@ The action itself lives [here](https://github.com/hacs/action) and you are free

All these checks can be disabled with `with.ignore`. Use a string, and if you ignore multiple ones, separate them with spaces.

| Check | More info | Description |
| ------------- | --------------------------------------------------------- | ------------------------------------------------ |
| `archived` | [More info](/docs/publish/include.md#check-archived) | Checks if the repository is archived |
| `brands` | [More info](/docs/publish/include.md#check-brands) | Checks if there are brand assets available |
| `description` | [More info](/docs/publish/include.md#check-repository) | Checks if the repository has a description |
| `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 |
| `issues` | [More info](/docs/publish/include.md#check-repository) | Checks that issues are enabled |
| `topics` | [More info](/docs/publish/include.md#check-repository) | Checks that the repository has topics |
| Check | More info | Description |
| ---------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------- |
| `archived` | [More info](/docs/publish/include.md#check-archived) | Checks if the repository is archived |
| `brands` | [More info](/docs/publish/include.md#check-brands) | Checks if there are brand assets available |
| `core_domain_override` | [More info](/docs/publish/include.md#check-core-domain-override) | Checks if the integration overrides a core integration domain |
| `description` | [More info](/docs/publish/include.md#check-repository) | Checks if the repository has a description |
| `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 |
| `issues` | [More info](/docs/publish/include.md#check-repository) | Checks that issues are enabled |
| `topics` | [More info](/docs/publish/include.md#check-repository) | Checks that the repository has topics |

## Using a specific version

Expand Down
7 changes: 7 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 @@ -59,6 +59,13 @@ _Applies only to integrations._
Checks that your integration has a brand directory with at least an `icon.png` file.
If it doesn’t, it falls back to checking the domain in the [home-assistant/brands](https://github.com/home-assistant/brands) repository.

### Check core domain override

_Applies only to integrations._

Checks that your integration does not use the same domain as an integration that is part of Home Assistant core.
Custom integrations that override a core integration are not accepted as defaults, see [Who can submit?](#who-can-submit).

### Check manifest

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.
Expand Down
Loading