Skip to content
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.

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

Add check-jsonschema to CI and pre-commit #131215

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

Conversation

autinerd
Copy link
Contributor

@autinerd autinerd commented Nov 21, 2024

Proposed change

This adds check-jsonschema to the CI and pre-commit to check the manifest.json files for violations of the JSON schema.

https://github.com/python-jsonschema/check-jsonschema

Needed before merge:

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant home-assistant bot added cla-signed code-quality small-pr PRs with less than 30 lines. labels Nov 21, 2024
@autinerd
Copy link
Contributor Author

The problem matcher works on the first try, yay 😅

@autinerd autinerd marked this pull request as ready for review November 22, 2024 15:02
@autinerd autinerd requested a review from a team as a code owner November 22, 2024 15:02
Comment on lines +44 to +47
alias: check-jsonschema-manifest
name: Validate manifest.json with jsonschema
files: ^homeassistant/components/.*/manifest.json$
args: ["--schemafile", "script/json_schemas/manifest_schema.json"]
Copy link
Member

Choose a reason for hiding this comment

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

We already validate the schema in hassfest?

@home-assistant home-assistant bot marked this pull request as draft November 22, 2024 15:54
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed code-quality small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants