Validation checks

Two kinds of checks look at your work. The HACS action runs in your own repository, and is what the catalog review runs too. The Marketplace runs its own checks when a user installs, and refuses an install that fails one. Both are below.

hacs/action runs the same validation as HACS, as a GitHub Action. Add it to your repository, in .github/workflows/validate.yaml:

name: Validate

on:
  push:
  pull_request:
  schedule:
    - cron: "0 0 * * *"
  workflow_dispatch:

permissions: {}

jobs:
  validate-hacs:
    runs-on: "ubuntu-latest"
    steps:
      - name: HACS validation
        uses: "hacs/action@main"
        with:
          category: "integration"

Set category to the type of your repository: integration, plugin for a dashboard plugin, theme, or template. The action also accepts appdaemon and python_script, types the Marketplace does not install.

This runs on every push and pull request, every night, and when you start it by hand from the Actions tab. To pin a version instead of main, use a tag after the @, and let Dependabot keep it up to date.

The catalog review runs more checks than these.

For integrations, also run hassfest, the same validation that integrations in core get. The catalog requires it.

name: Validate with hassfest

on:
  push:
  pull_request:
  schedule:
    - cron: "0 0 * * *"

jobs:
  validate:
    runs-on: "ubuntu-latest"
    steps:
      - uses: "actions/checkout@v4"
      - uses: "home-assistant/actions/hassfest@master"

The Marketplace checks before an install, and again after it wrote the files. When a check after writing fails, the files are put back the way they were before the install.

These checks live in the marketplace integration in core: homeassistant/components/marketplace/repositories/.