Skip to content

Conversation

@mgust
Copy link
Contributor

@mgust mgust commented Oct 18, 2025

Breaking change

Deprecating the legacy YAML configuration and adding automatic migration to ConfigEntry for the Prowl notification service.

Proposed change

Helping users migrate Prowl to the new ConfigFlow setup in preparation for deprecating the legacy YAML configuration and the legacy notification method.

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

Checklist

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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:

"issues": {
"prowl_yaml_deprecated": {
"title": "Prowl YAML configuration deprecated",
"description": "Configuring Prowl using YAML has been deprecated. An automatic import of your existing configuration has been made.\nPlease remove the Prowl configuration from configuration.yaml and update any automations to use the new `notify.send_message` action exposed with this new entity."
Copy link
Member

Choose a reason for hiding this comment

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

nd update any automations to use the new notify.send_message action exposed with this new entity.

Uh that sounds like a major breaking change or something that should be been raise repairs for separately; and not something that should be squeezed into this message.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, we do that too. https://github.com/home-assistant/core/pull/154727/files#diff-16a6406edebe12b764d2e6c7ccc098fdb11b4c7bcfcf1ab6edc46ce9f416f7ecR81 I just added it here to reinforce that there are more actions other than just migrating the YAML.
Should I perhaps phrase it better?

hass: HomeAssistant, issue_registry: ir.IssueRegistry
) -> None:
"""Test that YAML configuration triggers config entry creation."""
entry = get_config_entry(hass, TEST_API_KEY, config_method="import")
Copy link
Member

Choose a reason for hiding this comment

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

Instead of making a lookup, we can also just let the configure_prowl_through_yaml fixture return the config entry.

../Frenck

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there a method of getting the ConfigEntry after running async_setup_component that is different from doing essentially for entry in hass.config_entries.async_entries(DOMAIN):? (or maybe you just suggested to move it to the fixture to avoid the helper function?)

@home-assistant home-assistant bot marked this pull request as draft October 18, 2025 20:22
@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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants