Skip to main content

Include default repositories

As a developer you can now add your repository to be included in as a default repository in the store.

Only the owner of the repository or a major contributor to it can submit a PR to have it included as a default.

Custom integrations that exist to alpha/beta test core integrations will not be accepted, you can still use it as a custom repository

Custom integrations that override core integrations will not be accepted, you can still use it as a custom repository

Before submitting

Add both these actions to your own repository and make sure they pass:

When all of this is covered, you can add it to repository category files in https://github.com/hacs/default

caution

NB!: The list is case sensitive.

When a PR for this is merged, it will show up in HACS after the first scheduled scan.

CI Checks

When submitting a repository for the default repository a suite of CI checks will be run to ensure that the repository follows the requirements. All checks needs to pass for the repository to be included (unless something else are agreed on).

Re run checks

If you need to rerun the checks add a comment with this as the content:

/recheck

Check Brands

Only applies to integrations.

This checks that the repository are added to https://github.com/home-assistant/brands

Check Manifest

Only applies to integrations.

See Integration

For more information about the integration manifest see here https://developers.home-assistant.io/docs/creating_integration_manifest

Check HACS

This runs the same validation that HACS itself uses.

Check HACS Manifest

This checks that the hacs.json file at least contains the following:

  • name

https://hacs.xyz/docs/publish/start#hacsjson

Check Info

This checks that there is an info.md (or readme.md if configured) file with content in the repository.

Check Archived

This checks if the repository is archived.

Check Owner

This check can fail.

This checks if the submitter is the owner of repository, this can fail if the repository belong to an org. or that the submitter is a major contributor to the repository.

Check Images

Only applies to plugins and themes.

This checks that there are images in the defined information file that HACS render.

Check Repository

This checks general things about the repository like:

  • It has a description
  • Issues are enabled
  • It has topics defined

Lint [jq]

This make sure that the files still are valid JSON.

Lint [sorted]

This make sure that the files still are sorted correctly.