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

Validate quality scale tiers against the tier declared in the integration manifest #131286

Merged
merged 2 commits into from
Nov 22, 2024

Conversation

allenporter
Copy link
Contributor

Proposed change

Validate the integration quality scale rules against the tier declared in the manifest. Not sure if this was discussed or not, but it seemed like the logical next step for the validation.

You can also use this as a quick way to bootstrap your quality scale file by printing out the rules that are missing for the desired quality level.

$ $ python -m script.hassfest --plugins quality_scale
Integration google_tasks:
* [ERROR] [QUALITY_SCALE] Invalid homeassistant/components/google_tasks/quality_scale.yaml: required key not provided @ data['rules']. Got None
* [ERROR] [QUALITY_SCALE] Quality scale tier bronze requires quality scale rules to be met:
  unique-config-entry: todo
  config-flow: todo
  docs-installation-parameters: todo
  docs-installation-instructions: todo
  runtime-data: todo
  entity-event-setup: todo
  has-entity-name: todo
  docs-high-level-description: todo
  action-setup: todo
  test-before-setup: todo
  common-modules: todo
  test-before-configure: todo
  config-flow-test-coverage: todo
  dependency-transparency: todo
  docs-removal-instructions: todo
  brands: todo
  entity-unique-id: todo
  docs-actions: todo
  appropriate-polling: todo
* [ERROR] [QUALITY_SCALE] Quality scale tier silver requires quality scale rules to be met:
  integration-owner: todo
  entity-unavailable: todo
  log-when-unavailable: todo
  config-entry-unloading: todo
  reauthentication-flow: todo
  docs-installation-parameters: todo
  test-coverage: todo
  docs-configuration-parameters: todo
  action-exceptions: todo
  parallel-updates: todo
* [ERROR] [QUALITY_SCALE] Quality scale tier gold requires quality scale rules to be met:
  docs-data-update: todo
  entity-category: todo
  discovery: todo
  discovery-update-info: todo
  entity-translations: todo
  icon-translations: todo
  reconfiguration-flow: todo
  diagnostics: todo
  docs-known-limitations: todo
  docs-supported-functions: todo
  docs-examples: todo
  devices: todo
  docs-use-cases: todo
  docs-supported-devices: todo
  stale-devices: todo
  docs-troubleshooting: todo
  exception-translations: todo
  entity-disabled-by-default: todo
  repair-issues: todo
  entity-device-class: todo
  dynamic-devices: todo

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:

@allenporter allenporter requested a review from a team as a code owner November 22, 2024 15:36
@home-assistant home-assistant bot added cla-signed code-quality small-pr PRs with less than 30 lines. labels Nov 22, 2024
Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Nice! 👍

../Frenck

@frenck frenck merged commit 96e6737 into home-assistant:dev Nov 22, 2024
60 checks passed
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.

3 participants