Skip to content

Add config flow for simplepush#73471

Merged
MartinHjelmare merged 10 commits into
home-assistant:devfrom
engrbm87:simplepush
Jun 24, 2022
Merged

Add config flow for simplepush#73471
MartinHjelmare merged 10 commits into
home-assistant:devfrom
engrbm87:simplepush

Conversation

@engrbm87
Copy link
Copy Markdown
Contributor

@engrbm87 engrbm87 commented Jun 14, 2022

Breaking change

The Simplepush integration migrated to configuration via the UI. Configuring Simplepush via YAML configuration has been deprecated and will be removed in a future Home Assistant release.

Your existing YAML configuration is automatically imported on upgrade to this release; and thus can be safely removed from your YAML configuration after upgrading.

Proposed change

  • Add configuration flow for simplepush.
  • Allow specifying the event field as a data field in the notify service. Previously the event was specified in the YAML config which means had to create a separate instance for each event.
  • For users with existing YAML config the event is still taken from config if specified but it can be overridden in the service by adding an event key under data.

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

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.
  • [] For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • 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:

@probot-home-assistant probot-home-assistant Bot added config-flow This integration migrates to the UI by adding a config flow has-tests integration: simplepush new-feature labels Jun 14, 2022
Comment thread homeassistant/components/simplepush/notify.py Outdated
Comment thread tests/components/simplepush/test_config_flow.py Outdated
Comment thread homeassistant/components/simplepush/__init__.py
Comment thread homeassistant/components/simplepush/strings.json Outdated
Comment thread homeassistant/components/simplepush/notify.py Outdated
Comment thread homeassistant/components/simplepush/notify.py Outdated
Comment thread homeassistant/components/simplepush/__init__.py Outdated
Comment thread homeassistant/components/simplepush/config_flow.py Outdated
Comment thread tests/components/simplepush/test_config_flow.py
Comment thread homeassistant/components/simplepush/notify.py Outdated
Comment thread homeassistant/components/simplepush/notify.py Outdated
Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare 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!

@MartinHjelmare
Copy link
Copy Markdown
Member

Please update the breaking change paragraph with our standard message for these kinds of changes. Look at some merged PR by Frenck that added config flow.

Also please link a docs PR that adds config flow front matter and config flow configuration template.

@engrbm87
Copy link
Copy Markdown
Contributor Author

Please update the breaking change paragraph with our standard message for these kinds of changes. Look at some merged PR by Frenck that added config flow.

Also please link a docs PR that adds config flow front matter and config flow configuration template.

Hello @MartinHjelmare , I think this is ready now.

@MartinHjelmare
Copy link
Copy Markdown
Member

Thanks!

@MartinHjelmare MartinHjelmare merged commit d170886 into home-assistant:dev Jun 24, 2022
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 25, 2022
@engrbm87 engrbm87 deleted the simplepush branch August 19, 2022 08:53
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.

4 participants