Skip to content

[script] Document new default max_runs=5 for queued mode #5492

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

Merged
Parent: [waveshare_epaper]:add support for 4.26in B/W epaper.
merged 4 commits into from
Oct 19, 2025
Merged

[script] Document new default max_runs=5 for queued mode #5492

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
27df523
[script] Document new default max_runs=5 for queued mode
bdraco Oct 16, 2025
e626486
document confusing semantics
bdraco Oct 16, 2025
ba0a4f6
correct docs
bdraco Oct 16, 2025
1972bf1
Merge branch 'next' into unbound_script_queue
jesserockz Oct 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions content/components/script.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,22 @@ script:

- `single` : Do not start a new run. Issue a warning.
- `restart` : Start a new run after first stopping previous run.
- `queued` : Start a new run after previous runs complete.
- `queued` : Start a new run after previous runs complete. By default, allows up to 5 total instances (1 running + 4 queued).
When the limit is reached, additional calls are rejected with a warning.
- `parallel` : Start a new, independent run in parallel with previous runs.

- **max_runs** (*Optional*, int): Allows limiting the maximum number of runs when using script modes `queued` and
`parallel`, use value `0` for unlimited runs. Defaults to `0`.
- **max_runs** (*Optional*, int): Allows limiting the maximum number of script instances.
- For `queued` mode: Specifies max total instances (including the running one). Defaults to `5` (1 running + 4 queued). Valid range: 1-100.
- For `parallel` mode: Specifies max parallel instances. Defaults to `0` (unlimited). Valid range: 0-100.

```yaml
script:
- id: my_script
mode: queued
max_runs: 10 # Allow up to 10 total instances (1 running + 9 queued)
then:
- logger.log: "Processing..."
```

- **parameters** (*Optional*, [Script Parameters](#script-parameters)): A script can define one or more parameters
that must be provided in order to execute. All parameters defined here are mandatory and must be given when calling
Expand Down