Skip to content
terminal

GitHub Action

HACS Action

22.5.0 Latest version

HACS Action

terminal

HACS Action

Repository validation action for HACS

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: HACS Action

              
  uses: hacs/action@22.5.0
Learn more about this action in hacs/action

Choose a version

HACS Action

Repository validation action for HACS

Inputs

Input Description
ignore A space seperated list of ignored checks
category The type of repository (integration, plugin, template, theme, netdaemon, appdaemon, python_script)

Example

name: HACS Action

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

jobs:
  hacs:
    name: HACS Action
    runs-on: "ubuntu-latest"
    steps:
      - name: HACS Action
        uses: "hacs/action@main"
        with:
          category: "CHANGE_ME!"

Ignorable checks

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

Check More info Description
archived More info Checks if the repository is archived
brands More info Checks if the domain is added to the brands repo
description More info Checks if the repository has a description
hacsjson More info Checks that hacs.json exists
images More info Checks that the info file has images
information More info Checks that the repo has an information file
issues More info Checks that issues are enabled
topics More info Checks that the repository has topics

Versions

To use a specific version of this action instead of main set the value after @ in the uses definition, like:

uses: hacs/action@xx.xx.x

If you do this, please enable dependabot to help you keep that up to date.