Skip to content

Add ask question to release notes #39792

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

Merged
merged 4 commits into from
Jul 1, 2025

Conversation

jlpouffier
Copy link
Member

@jlpouffier jlpouffier commented Jul 1, 2025

Proposed change

Complete the section related to ask_question on the release note for the 2025.7 release.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Introduced a new blueprint for asking Yes/No questions via voice assistants, supporting 50 different ways of saying "Yes" and "No," customizable responses, and retry logic.
  • Documentation
    • Updated release notes with detailed instructions, a screenshot, a demonstration video, and example YAML for the new "Ask Question" action in Assist, enhancing guidance for creating conversational automations.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch rc This PR is against the RC branch labels Jul 1, 2025
@home-assistant
Copy link

home-assistant bot commented Jul 1, 2025

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

Copy link

netlify bot commented Jul 1, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 1116d8e
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6863d6f73670ee0007b72de9
😎 Deploy Preview https://deploy-preview-39792--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jlpouffier jlpouffier marked this pull request as ready for review July 1, 2025 10:34
Copy link
Contributor

coderabbitai bot commented Jul 1, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The updates introduce a new Home Assistant blueprint for asking yes/no questions via voice assistants, along with enhanced release notes. The release notes now include detailed descriptions, a screenshot, a demonstration video, a blueprint import badge, and example YAML. The blueprint supports advanced response recognition and retry logic for conversational automations.

Changes

File(s) Change Summary
source/_posts/2025-07-02-release-20257.markdown Updated release notes: added actual content for "Ask Question" action, screenshot, blueprint badge, video, and YAML example.
source/blueprints/blog/2025-07/ask_yes_no_question.yaml Added new blueprint: "Ask a Yes/No question" with support for 50 response phrases, retry logic, and custom actions.

Sequence Diagram(s)

sequenceDiagram
    participant Automation
    participant VoiceAssistant
    participant User

    Automation->>VoiceAssistant: Ask yes/no question (via assist_satellite.ask_question)
    VoiceAssistant->>User: Announces question (optional preannouncement)
    User-->>VoiceAssistant: Responds (various yes/no/other phrases)
    VoiceAssistant->>Automation: Returns response (matched to yes/no/other)
    alt Response is "yes"
        Automation->>VoiceAssistant: Execute "yes" actions and announce positive answer
    else Response is "no"
        Automation->>VoiceAssistant: Execute "no" actions and announce negative answer
    else Response unrecognized and retries left
        Automation->>VoiceAssistant: Repeat question (increment retry count)
    else Retries exhausted
        Automation->>VoiceAssistant: Execute "other" actions and announce fallback answer
    end
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between defec27 and 1116d8e.

📒 Files selected for processing (1)
  • source/blueprints/blog/2025-07/ask_yes_no_question.yaml (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (3)
source/blueprints/blog/2025-07/ask_yes_no_question.yaml (1)

2-2: Double / in blueprint name looks like a typo

The public-facing name will render with a double slash (“Yes//No”), which feels accidental and might confuse users.

-  name: Ask a Yes//No question
+  name: Ask a Yes/No question
source/_posts/2025-07-02-release-20257.markdown (2)

112-112: Trailing whitespace triggers markdown-lint

Static analysis (MD009) already flagged this. Trim to keep the linter green.

-This blueprint allows you to focus on what you want to do if you answer positively or negatively to any question your voice assistant will ask, the blueprint supports 50 different ways of saying "Yes" and "No". ␠
+This blueprint allows you to focus on what you want to do if you answer positively or negatively to any question your voice assistant will ask; the blueprint supports 50 different ways of saying "Yes" and "No".

110-110: Bare URL violates MD034

Embed the URL in markdown to avoid a bare link warning:

-{% my blueprint_import badge blueprint_url="https://www.home-assistant.io/blueprints/blog/2025-07/ask_yes_no_question.yaml" %}
+{% my blueprint_import 'Ask a Yes/No question' 'https://www.home-assistant.io/blueprints/blog/2025-07/ask_yes_no_question.yaml' %}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between e42d153 and defec27.

⛔ Files ignored due to path filters (1)
  • source/images/blog/2025-07/ask_question.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • source/_posts/2025-07-02-release-20257.markdown (1 hunks)
  • source/blueprints/blog/2025-07/ask_yes_no_question.yaml (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_posts/2025-07-02-release-20257.markdown

110-110: Bare URL used

(MD034, no-bare-urls)


112-112: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

🔇 Additional comments (1)
source/blueprints/blog/2025-07/ask_yes_no_question.yaml (1)

216-218: Verify templating of the sentence lists

sentences: "{{yes_sentences}}" (and the same for no_sentences) returns a Python list at runtime.
While recent HA versions accept non-string template output, older ones serialise it to a string, breaking phrase matching.

Please confirm on a live instance ≥ 2025.6 that assist_satellite.ask_question receives an actual list.
If not, convert explicitly:

sentences: "{{ yes_sentences | list }}"

@frenck frenck requested a review from Copilot July 1, 2025 11:09
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR completes the release notes for the 2025.7 release by adding the new “Ask Question” blueprint and updating the blog post with an image, blueprint badge, and demo video.

  • Introduces a new blueprint (ask_yes_no_question.yaml) for asking closed Yes/No questions via Assist with customizable responses.
  • Updates the July release blog post to include the blueprint badge, screenshot, example YAML, and demo video.

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.

File Description
source/blueprints/blog/2025-07/ask_yes_no_question.yaml Adds a new Ask Yes/No question blueprint with inputs, variables, and sequence logic.
source/_posts/2025-07-02-release-20257.markdown Embeds screenshot, blueprint badge, example YAML, and demo video into the release notes.
Comments suppressed due to low confidence (2)

source/_posts/2025-07-02-release-20257.markdown:112

  • [nitpick] This sentence is a run-on. Consider splitting into two sentences for readability, for example: This blueprint lets you focus on what happens when you reply positively or negatively to a question. It supports 50 different ways of saying "Yes" and "No".
This blueprint allows you to focus on what you want to do if you answer positively or negatively to any question your voice assistant will ask, the blueprint supports 50 different ways of saying "Yes" and "No". 

source/_posts/2025-07-02-release-20257.markdown:118

  • [nitpick] Add the missing article for clarity: how to ask a question instead of how to ask question.
In case you want to dive deeper into conversation building, here is an example on how to ask question and process the different answers:

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @jlpouffier 👍

../Frenck

@frenck frenck merged commit 4bd9d3f into home-assistant:rc Jul 1, 2025
6 of 7 checks passed
@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch and removed in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Jul 1, 2025
@home-assistant
Copy link

home-assistant bot commented Jul 1, 2025

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@github-actions github-actions bot locked and limited conversation to collaborators Jul 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch rc This PR is against the RC branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants