Repository navigation
Conversation
The --schedule-to-start-timeout help on update-options described the
scheduling-time default ("schedule-to-close timeout or workflow execution
timeout"). On update-options an omitted flag leaves the stored value
unchanged, and 0s clears it, after which the server sets it to the
schedule-to-close timeout.
Also explain in the command description that the server re-applies its
timeout caps after the update, so lowering schedule-to-close lowers the
others, but raising it doesn't raise them.
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related issues
Docs side: temporalio/documentation#5490 (Activity timeout defaults and how Update Options resolves timeouts). That PR previously hand-edited the generated
activity.mdxreference. This change replaces that edit, and the docs reference picks it up on the next CLI release.What changed?
Help text only, for
temporal activity update-options:--schedule-to-start-timeout: the help said an omitted value "defaults to the schedule-to-close timeout or workflow execution timeout." That describes scheduling, not updating. Onupdate-options, the CLI only adds a field to the update mask when you pass its flag (commands.activity.go), so omitting the flag leaves the stored value unchanged. Passing0sclears it, and the server then sets it to the schedule-to-close timeout.service/history/api/updateactivityoptions/api.go,chasm/lib/activity/operator_commands.go). Lowering schedule-to-close lowers the others. Raising it doesn't raise them, so pass--start-to-close-timeouttoo if each attempt needs more time.commands.gen.gois regenerated withmake gen.Checklist
Help text
The
0sin the flag description is deliberately not in backticks: pflag treats a backticked word in a flag's usage as its type name, which made the flag render as--schedule-to-start-timeout 0sinstead ofduration.Manual tests
Setup
activity describeshows schedule-to-close, schedule-to-start, and start-to-close all at86400s.Happy path (each step followed by
temporal activity describe --activity-id YourActivityId -o json)--schedule-to-close-timeout 48h--schedule-to-close-timeout 1h--schedule-to-start-timeout 10m--heartbeat-timeout 30s(schedule-to-start omitted)--schedule-to-start-timeout 0s--heartbeat-timeout 2his stored as1h0m0s, capped at start-to-close.Help output