[script] Document new default max_runs=5 for queued mode #5492
+14
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR documents a breaking change to the max_runs default behavior for queued scripts in ESPHome. The key change is that queued mode now defaults to max_runs: 5 (allowing 1 running + 4 queued instances) instead of unlimited runs, with additional calls rejected when the limit is reached.
Key Changes
- Documents new default
max_runs: 5for queued mode (previously unlimited) - Clarifies that
max_runsrepresents total instances including the running one - Adds example demonstrating how to override the default limit
jesserockz
approved these changes
Oct 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Updates script component documentation to reflect the breaking change in default
max_runsbehavior for queued scripts.Changes:
max_runs: 5for queued mode (was unlimited)max_runsspecifies max total instances (including the running one)Related issue (if applicable): N/A - Breaking change documentation
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.