8000 Add config block to media selector by balloob · Pull Request #39696 · home-assistant/home-assistant.io · GitHub
[go: up one dir, main page]

Skip to content

Add config block to media selector #39696

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 2 commits into from
Jun 24, 2025
Merged

Add config block to media selector #39696

merged 2 commits into from
Jun 24, 2025

Conversation

balloob
Copy link
Member
@balloob balloob commented Jun 24, 2025

Proposed change

Add missing config block for media selector.

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

  • Documentation
    • Expanded media selector documentation with additional usage examples and configuration details.
    • Added explanation for using the media selector without options and with an optional accept filter.
    • Introduced documentation for the optional accept parameter to restrict selectable media types.
    • Improved formatting in the object selector example.

@Copilot Copilot AI review requested due to automatic review settings June 24, 2025 16:59
@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 next This PR goes into the next branch labels Jun 24, 2025
@home-assistant
Copy link

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 Jun 24, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 7b1dea8
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/685adabdf70d730008c5a38a
😎 Deploy Preview https://deploy-preview-39696--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.

@balloob balloob force-pushed the media-config-var branch from 00d72c9 to 41e7b81 Compare June 24, 2025 16:59
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 updates the blueprint selectors documentation to include examples and configuration details for the media selector.

  • Added a new index entry for an example on merging with existing triggers.
  • Provided usage examples for the media selector (with and without an accept filter).
  • Introduced a configuration block for the accept option.
Comments suppressed due to low confidence (2)

source/_docs/blueprint/selectors.markdown:1043

  • The code snippet includes a stray hyphen before the comment. Change -# to # so that the YAML example is valid.
```yaml

source/_docs/blueprint/selectors.markdown:1049

  • The configuration block appears incomplete and uses configuration area. It should follow the established pattern by wrapping the full media selector configuration under {% configuration %} and including the parent key (for example, media: then nested selector details).
{% configuration area %}

Copy link
Contributor
coderabbitai bot commented Jun 24, 2025
📝 Walkthrough

Walkthrough

The documentation for the media selector was updated to include two new usage examples and a configuration block describing the optional accept parameter. Additionally, a minor formatting fix was applied to the object selector example.

Changes

File Change Summary
source/_docs/blueprint/selectors.markdown Added two new media selector usage examples, described the optional accept filter, and fixed formatting in the object selector example.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.


📜 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 41e7b81 and 7b1dea8.

📒 Files selected for processing (1)
  • source/_docs/blueprint/selectors.markdown (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_docs/blueprint/selectors.markdown
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs

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 CodeRa 8000 bbit 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: 1

🧹 Nitpick comments (1)
source/_docs/blueprint/selectors.markdown (1)

1056-1056: Tiny grammar nit – “a mapping”, not “an mapping”

-The output of the media selector, is an mapping with information about
+The output of the media selector is a mapping with information about
📜 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 c5a0d7c and 41e7b81.

📒 Files selected for processing (1)
  • source/_docs/blueprint/selectors.markdown (2 hunks)
🔇 Additional comments (2)
source/_docs/blueprint/selectors.markdown (2)

1032-1041: Clarity additions look good

Nice addition of concrete usage examples for both the default and accept-filtered variants; phrasing is clear and matches actual behaviour in the UI.


1197-1197: Indentation fix restores YAML correctness

The extra two-space indent for selector: aligns the sample with previous code blocks and prevents copy-paste errors.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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, @balloob 👍

../Frenck

@frenck frenck merged commit e39aa8d into next Jun 24, 2025
9 checks passed
@frenck frenck deleted the media-config-var branch June 24, 2025 19:03
@home-assistant home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on labels Jun 24, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jun 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0