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

Deprecate opentherm_gw configuration through configuration.yaml #125045

Merged
merged 3 commits into from
Sep 8, 2024

Conversation

mvn23
Copy link
Contributor

@mvn23 mvn23 commented Sep 2, 2024

Proposed change

Configuration of the OpenTherm Gateway integration through configuration.yaml has been obsolete since Home Assistant 0.101.0.
With this PR, we deprecate that configuration method to allow removal of the old code in the future.
If a user still has opentherm_gw config in their yaml files, they will be asked to remove it through an issue in the issue registry. This issue will not be created for users who do not have the old config in their yaml files.

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:

* Create an issue in the issue registry if deprecated config is found in configuration.yaml
* Add deprecation comments to functions that can be removed after deprecation period
* Add test for the creation of a deprecation issue
@home-assistant home-assistant bot added cla-signed deprecation Indicates a breaking change to happen in the future has-tests integration: opentherm_gw small-pr PRs with less than 30 lines. by-code-owner Quality Scale: No score labels Sep 2, 2024
Copy link
Contributor

@davet2001 davet2001 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

Thanks @mvn23!

mvn23 and others added 2 commits September 7, 2024 13:38
Fix merge conflicts
Update tests with newly added fixtures since original branching
@joostlek joostlek merged commit 45ab6e9 into home-assistant:dev Sep 8, 2024
29 checks passed
@mvn23 mvn23 deleted the deprecate-opentherm-old-config branch September 9, 2024 08:13
@github-actions github-actions bot locked and limited conversation to collaborators Sep 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants