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

Block custom integrations with missing or invalid version #49916

Merged
merged 12 commits into from
May 17, 2021

Conversation

ludeeus
Copy link
Member

@ludeeus ludeeus commented Apr 30, 2021

Breaking change

As mentioned in every release since 2021.3, custom integrations will require a version key in their manifest file.
If that key is missing, the custom integration will no longer be loaded.

For more details see https://developers.home-assistant.io/blog/2021/01/29/custom-integration-changes#versions

Proposed change

The last part of the plan outlined in https://developers.home-assistant.io/blog/2021/01/29/custom-integration-changes#versions. With this custom integrations that are missing the version key, or have an invalid version key will no longer be loaded.

That also means that legacy integrations will not load with this, since those do not have a manifest file.

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)
  • 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
  • The code has been formatted using Black (black --fast 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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

Copy link
Contributor

@alandtse alandtse left a comment

Choose a reason for hiding this comment

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

LGTM. Shouldn't there be a doc PR to identify the fact it's no longer a future requirement?

@ludeeus
Copy link
Member Author

ludeeus commented May 3, 2021

The documentation always stated that it's required https://developers.home-assistant.io/docs/creating_integration_manifest#version

EDIT: The blog post stated it was a future version home-assistant/developers.home-assistant#912

homeassistant/loader.py Outdated Show resolved Hide resolved
homeassistant/loader.py Show resolved Hide resolved
@frenck frenck merged commit 2f10f59 into dev May 17, 2021
@frenck frenck deleted the block-integrations-without-version branch May 17, 2021 13:48
@github-actions github-actions bot locked and limited conversation to collaborators May 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants