Skip to content

Triggers: rename behavior options: any->each, last->all#45692

Merged
silamon merged 5 commits into
currentfrom
triggers-behavior-rename-options
Jun 3, 2026
Merged

Triggers: rename behavior options: any->each, last->all#45692
silamon merged 5 commits into
currentfrom
triggers-behavior-rename-options

Conversation

@c0ffeeca7
Copy link
Copy Markdown
Contributor

@c0ffeeca7 c0ffeeca7 commented Jun 2, 2026

Proposed change

Not to be merged before 2026.6. release.

rename YAML behavior options in documented triggers to match UI wording (and to match changed YAML options)

see home-assistant/core#166950

Here's what we're changing:

  • any becomes each
  • first stays
  • last becomes all

Related to: home-assistant/frontend#52217, home-assistant/core#172348, home-assistant/frontend#52360

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

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.

Copilot AI review requested due to automatic review settings June 2, 2026 06:10
@home-assistant home-assistant Bot added current This PR goes into the current branch has-parent This PR has a parent PR in another repo 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 Jun 2, 2026
@home-assistant
Copy link
Copy Markdown

home-assistant Bot commented Jun 2, 2026

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 2, 2026

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit d178ee6
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6a1e7839ba939f00080274e8
😎 Deploy Preview https://deploy-preview-45692--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@c0ffeeca7 c0ffeeca7 removed their assignment Jun 2, 2026
@c0ffeeca7 c0ffeeca7 requested a review from emontnemery June 2, 2026 06:13
@c0ffeeca7 c0ffeeca7 changed the title Triggers behavior rename options Triggers: rename behavior options: any-each, last-all Jun 2, 2026
Copy link
Copy Markdown
Contributor

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 Home Assistant docs for Labs entity triggers to reflect the renamed YAML behavior option values, aligning the YAML with the UI wording.

Changes:

  • Renames documented YAML behavior values from any/first/last to each/first/all, including defaults.
  • Updates YAML examples and explanatory text across many trigger reference pages to use the new values.
  • Adjusts the shared “behavior with multiple targets” include to match the updated terminology.

Reviewed changes

Copilot reviewed 95 out of 95 changed files in this pull request and generated 13 comments.

Show a summary per file
File Description
source/_triggers/window.opened.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/window.closed.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/valve.opened.markdown Update YAML behavior option list and default to each/first/all.
source/_triggers/valve.closed.markdown Update YAML behavior option list and default to each/first/all.
source/_triggers/vacuum.started_returning.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/vacuum.started_cleaning.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/vacuum.paused_cleaning.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/vacuum.errored.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/vacuum.docked.markdown Update YAML examples/text and options to each/first/all.
source/_triggers/update.update_became_available.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/timer.started.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/timer.restarted.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/timer.paused.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/timer.finished.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/timer.cancelled.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/temperature.crossed_threshold.markdown Update YAML behavior list and default to each/first/all.
source/_triggers/siren.turned_on.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/siren.turned_off.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/motion.detected.markdown Update YAML behavior option list and default to each/first/all.
source/_triggers/motion.cleared.markdown Update YAML behavior option list and default to each/first/all.
source/_triggers/moisture.detected.markdown Update YAML behavior list and default to each/first/all.
source/_triggers/moisture.crossed_threshold.markdown Update YAML behavior usage and option list to each/first/all.
source/_triggers/moisture.cleared.markdown Update YAML behavior list and default to each/first/all.
source/_triggers/lock.unlocked.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/lock.opened.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/lock.locked.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/lock.jammed.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/light.turned_on.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/light.turned_off.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/light.brightness_crossed_threshold.markdown Update YAML behavior usage and option list to each/first/all.
source/_triggers/lawn_mower.started_returning.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/lawn_mower.started_mowing.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/lawn_mower.paused_mowing.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/lawn_mower.errored.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/lawn_mower.docked.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/illuminance.detected.markdown Update YAML behavior list and default to each/first/all.
source/_triggers/illuminance.crossed_threshold.markdown Update YAML behavior list and default to each/first/all.
source/_triggers/illuminance.cleared.markdown Update YAML behavior list and default to each/first/all.
source/_triggers/humidity.crossed_threshold.markdown Update YAML behavior usage and option list to each/first/all.
source/_triggers/humidifier.turned_on.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/humidifier.turned_off.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/humidifier.started_humidifying.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/humidifier.started_drying.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/humidifier.mode_changed.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/gate.opened.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/gate.closed.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/garage_door.opened.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/garage_door.closed.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/fan.turned_on.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/fan.turned_off.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/door.opened.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/door.closed.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/counter.reset.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/counter.minimum_reached.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/counter.maximum_reached.markdown Update YAML behavior values and default to each/first/all.
source/_triggers/climate.turned_on.markdown Update YAML behavior list and default to each/first/all.
source/_triggers/climate.turned_off.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/climate.target_temperature_crossed_threshold.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/climate.target_humidity_crossed_threshold.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/climate.started_heating.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/climate.started_drying.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/climate.started_cooling.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/climate.hvac_mode_changed.markdown Update UI/YAML behavior wording and YAML values to each/first/all.
source/_triggers/battery.stopped_charging.markdown Update YAML behavior list and default to each/first/all.
source/_triggers/battery.started_charging.markdown Update YAML behavior list and default to each/first/all.
source/_triggers/battery.not_low.markdown Update YAML behavior option list and default to each/first/all.
source/_triggers/battery.low.markdown Update YAML examples and option list to each/first/all.
source/_triggers/battery.level_crossed.markdown Update YAML examples and option list to each/first/all.
source/_triggers/alarm_control_panel.triggered.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/alarm_control_panel.disarmed.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/alarm_control_panel.armed.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/alarm_control_panel.armed_vacation.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/alarm_control_panel.armed_night.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/alarm_control_panel.armed_home.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/alarm_control_panel.armed_away.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/air_quality.voc_ratio_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.voc_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.so2_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.smoke_detected.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/air_quality.smoke_cleared.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/air_quality.pm4_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.pm25_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.pm10_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.pm1_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.ozone_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.no2_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.no_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.n2o_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.gas_detected.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/air_quality.gas_cleared.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/air_quality.co2_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.co_detected.markdown Update YAML behavior values and examples to each/first/all.
source/_triggers/air_quality.co_crossed_threshold.markdown Update YAML behavior usage, option list, and default to each/first/all.
source/_triggers/air_quality.co_cleared.markdown Update YAML behavior values and examples to each/first/all.
source/_includes/triggers/behavior.md Update shared behavior explanation to reflect renamed YAML behavior values.

Comment thread source/_includes/triggers/behavior.md
Comment thread source/_triggers/climate.target_temperature_crossed_threshold.markdown Outdated
Comment thread source/_triggers/climate.turned_on.markdown Outdated
Comment thread source/_triggers/humidifier.turned_on.markdown Outdated
Comment thread source/_triggers/humidifier.turned_on.markdown Outdated
Comment thread source/_triggers/humidifier.started_humidifying.markdown Outdated
Comment thread source/_triggers/humidifier.started_drying.markdown Outdated
Comment thread source/_triggers/humidifier.started_drying.markdown Outdated
Comment thread source/_triggers/humidifier.mode_changed.markdown Outdated
Comment thread source/_triggers/humidifier.mode_changed.markdown Outdated
@c0ffeeca7 c0ffeeca7 changed the title Triggers: rename behavior options: any-each, last-all Triggers: rename behavior options: any->each, last->all Jun 2, 2026
@c0ffeeca7 c0ffeeca7 marked this pull request as draft June 2, 2026 06:18
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@c0ffeeca7 c0ffeeca7 marked this pull request as ready for review June 2, 2026 06:20
@c0ffeeca7 c0ffeeca7 requested a review from a team as a code owner June 2, 2026 06:29
Copy link
Copy Markdown
Contributor

@silamon silamon left a comment

Choose a reason for hiding this comment

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

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

@home-assistant home-assistant Bot marked this pull request as draft June 2, 2026 10:36
@home-assistant
Copy link
Copy Markdown

home-assistant Bot commented Jun 2, 2026

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@silamon
Copy link
Copy Markdown
Contributor

silamon commented Jun 2, 2026

We're actually pushing documentation to current that will work on the stable that ships tomorrow.

@fdmarcin
Copy link
Copy Markdown
Contributor

fdmarcin commented Jun 3, 2026

We're actually pushing documentation to current that will work on the stable that ships tomorrow.

@silamon @c0ffeeca7 so, this could already be merged because home-assistant/core#172348 is going to be in 2026.6?

In my latest PR #45730 I used the new options. I'll keep it in draft until tomorrow.

@silamon
Copy link
Copy Markdown
Contributor

silamon commented Jun 3, 2026

@silamon @c0ffeeca7 so, this could already be merged because home-assistant/core#172348 is going to be in 2026.6?

Well, release is going to be in 4 hours. then it can be merged. You can have them prepared and merge them in. But talking about flows, things that are for the next release should go on to next. That way we can make it available for users who are following nightly instead of stable.

@silamon silamon marked this pull request as ready for review June 3, 2026 15:17
@home-assistant home-assistant Bot requested a review from silamon June 3, 2026 15:17
@silamon silamon merged commit 441e843 into current Jun 3, 2026
8 of 9 checks passed
@silamon silamon deleted the triggers-behavior-rename-options branch June 3, 2026 15:17
@home-assistant home-assistant Bot 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 Jun 3, 2026
@c0ffeeca7
Copy link
Copy Markdown
Contributor Author

Apologies for causing confusion here. I'm aware it should have been targeting next. I chose current because most of these were documented on current. My intent was to have it ready for review before the release, then merge it afterward. But I realize that this is not following the process.

@github-actions github-actions Bot locked and limited conversation to collaborators Jun 4, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

current This PR goes into the current branch has-parent This PR has a parent PR in another repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

triggers (lab feature): rename YAML behavior options

4 participants