Skip to content

Document license check requirement for repository publishing #687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ludeeus wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Document license check requirement for repository publishing #687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09c1657
Document the new license check for the HACS Action
claude May 20, 2026
e623b1b
Drop external license links from Check license section
claude May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/docs/publish/action.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ All these checks can be disabled with `with.ignore`. Use a string, and if you ig
| `images` | [More info](/docs/publish/include.md#check-images) | Checks that the info file has images |
| `information` | [More info](/docs/publish/include.md#check-repository) | Checks that the repo has an information file |
| `issues` | [More info](/docs/publish/include.md#check-repository) | Checks that issues are enabled |
| `license` | [More info](/docs/publish/include.md#check-license) | Checks that the repository has a recognized open source license |
| `topics` | [More info](/docs/publish/include.md#check-repository) | Checks that the repository has topics |

## Using a specific version
Expand Down
6 changes: 6 additions & 0 deletions source/docs/publish/include.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,12 @@ Checks general repository requirements:
- The repository has issues enabled
- The repository has topics defined

### Check license

Checks that the repository declares a recognized open source license that GitHub can detect.

GitHub detects the license from a `LICENSE` file at the repository root that matches a recognized SPDX template. Repositories with no license, or where GitHub classifies the license as `other`, will fail this check.

### lint jq

Ensures that the files in your PR are valid JSON.
Expand Down
Loading