Skip to content

Document integration categories validation check - #711

Open
ludeeus wants to merge 2 commits into
mainfrom
claude/charming-pasteur-rrd7br
Open

ludeeus wants to merge 2 commits into
mainfrom
claude/charming-pasteur-rrd7br

Conversation

@ludeeus

@ludeeus ludeeus commented Oct 19, 2026

Copy link
Copy Markdown
Member

Summary

Added documentation for the new integration categories validation check in the HACS action, including details about the categories key in manifest.json and how to use it.

Key Changes

  • Added new "Check integration categories" section to include.md explaining:

    • The purpose of the categories key validation
    • Requirements: values must be from Home Assistant core categories or subcategories
    • Constraints: each category listed only once, maximum 3 categories
    • Behavior: check passes with warning if categories key is missing
    • Reference link to available categories in Home Assistant documentation
  • Updated integration.md to reference the new categories validation check and note that categories is an optional key in manifest.json

  • Added integration_categories check to the action checks table in action.md with link to the detailed documentation

Notable Details

  • The validation check is specific to integrations only
  • The check provides guidance through warnings rather than failures for missing categories
  • Documentation includes a link to the Home Assistant core documentation for available category options

https://claude.ai/code/session_019AkoL9MLyMsmu8awMfnagS

Describe the new integration_categories action check, add it to the
ignorable checks, and mention the optional categories key in the
integration manifest requirements.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019AkoL9MLyMsmu8awMfnagS
Add only the integration_categories row instead of realigning the
whole table.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019AkoL9MLyMsmu8awMfnagS
Copilot AI balanced review requested due to automatic review settings October 19, 2026 14:02

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation changes are consistent and correctly cross-linked, with no identified blocking issues.

No open issues 🎉

What changed in this PR

Documents the HACS action’s integration categories validation and connects it to the publishing guidance.

Changes:

  • Explains allowed categories, uniqueness, the three-category limit, and warnings when omitted.
  • Documents the optional manifest key and adds the check to the action reference.
File Description
source/​docs/​publish/​integration.md Introduces the optional categories key and links to validation guidance.
source/​docs/​publish/​include.md Explains category validation requirements and behavior.
source/​docs/​publish/​action.md Lists the integration_categories check.

Review effort: Balanced

@ludeeus
ludeeus marked this pull request as ready for review October 19, 2026 14:05

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants