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

Refactor the MQTT option and reconfigure flow #133342

Open
wants to merge 10 commits into
base: dev
Choose a base branch
from

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Dec 16, 2024

Breaking change

To reconfigure the MQTT broker settings users need to start a Reconfigure flow. When CONFIGURE is selected MQTT show a page "MQTT settings" with subscribe and publish tools. The Re-configure MQTT buttton will be replaced with a MQTT options page. The reconfiguration option will only be available from the MQTT Config Entry context menu.

Proposed change

Exclude the MQTT broker setup from the MQTT option flow and move the broker options to the config entry options.
Reconfiguration support was already added with: #132246

The special MQTT config entry page for the MQTT entry needs an update to clarify the MQTT options can be set from there.

Needs:

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

  • 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:

@home-assistant
Copy link

Hey there @emontnemery, @bdraco, mind taking a look at this pull request as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign mqtt Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@jbouwh jbouwh changed the title Mqtt-refactor-option-flow Refactor the MQTT option and reconfigue flow Dec 16, 2024
@epenet epenet changed the title Refactor the MQTT option and reconfigue flow Refactor the MQTT option and reconfigure flow Dec 16, 2024
@jbouwh jbouwh force-pushed the mqtt-refactor-option-flow branch from b87b868 to 5fb4924 Compare December 17, 2024 09:12
@jbouwh jbouwh marked this pull request as ready for review December 17, 2024 09:13
@jbouwh
Copy link
Contributor Author

jbouwh commented Dec 17, 2024

Frontend PR was approved

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.

3 participants