Home AssistantHome AssistantContributors

    ↑↓ to moveEnter to openEsc to close

    Hassfest

    The tool in Home Assistant Core that validates the files of every integration, like its manifest and translations, and generates files from them.

    In code
    script/hassfestpython -m script.hassfest

    Hassfest checks that the files around the code of an integration, like manifest.json, strings.json, services.yaml, and quality_scale.yaml, are complete and consistent. It also generates files from them, like CODEOWNERS and the lists in homeassistant/generated/.

    It runs in CI on every pull request to Home Assistant Core, and you can run it yourself with python -m script.hassfest. Custom integrations can use it too, with the hassfest action from the home-assistant/actions repository. See Linters, hassfest, and CI.

    Related terms

    • ManifestThe `manifest.json` file of an integration: its domain, name, integration owners, requirements, and how it can be discovered.
    • Translation keyThe key that points to a text in an integration's `strings.json`, so the text can be translated. Integrations use keys, not English text in the code.
    • Integration quality scaleTiers that integrations earn by following rules for code quality and user experience: Bronze, Silver, Gold, and Platinum.
    • CIContinuous integration: the automated checks, like tests, linters, and type checks, that run on every pull request.