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.

Sign up for GitHub

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

Jump to bottom

Add data descriptions to MQTT config flow. #105301

Merged
merged 2 commits into from Dec 15, 2023
Merged

Add data descriptions to MQTT config flow. #105301

merged 2 commits into from Dec 15, 2023

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Dec 8, 2023

Proposed change

Add data descriptions to MQTT config flow.

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Dec 8, 2023

Hey there @emontnemery, 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.

@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Dec 8, 2023
joostlek
joostlek reviewed Dec 15, 2023
View reviewed changes
homeassistant/components/mqtt/strings.json Outdated
"client_id": "The unique ID to identify the Home Assistant MQTT API as MQTT client. It is recommended to leave this option blank.",
"client_cert": "The client certificate to authenticate against your MQTT broker.",
"client_key": "The private key file that belongs to your client certificate.",
"keepalive": "The time between sending keep alive messages",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"keepalive": "The time between sending keep alive messages",
"keepalive": "The time between sending keep alive messages in seconds.",

Does this make sense?

@jbouwh jbouwh merged commit b4741c2 into dev Dec 15, 2023
53 checks passed
@jbouwh jbouwh deleted the jbouwh-mqtt-add-data_descriptions branch December 15, 2023 15:30
Bre77 pushed a commit to Bre77/core that referenced this pull request Dec 15, 2023
@jbouwh @Bre77
Add data descriptions to MQTT config flow. (home-assistant#105301)
accb648 
* Add data descriptions to MQTT config flow.

* Remove keep allive, correct text CA cert
@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@joostlek joostlek joostlek approved these changes

@emontnemery emontnemery Awaiting requested review from emontnemery emontnemery is a code owner

Assignees

@emontnemery emontnemery

Labels
by-code-owner cla-signed code-quality core integration: mqtt Quality Scale: gold smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@jbouwh @joostlek @frenck @emontnemery