Skip to content
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

add temporal --command-timeout global option #3162

Merged
merged 3 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/cli/activity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -95,7 +95,7 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--detail](/cli/cmd-options#detail)

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/batch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -140,7 +140,7 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -185,7 +185,7 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/cmd-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,9 @@ When to use color: auto, always, never. (default: auto)

Request concurrency.

## context-timeout
## command-timeout

An optional timeout for the context of an RPC call (in seconds).
The command execution timeout. 0s means no timeout.

## cron

Expand Down
8 changes: 4 additions & 4 deletions docs/cli/env.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Use the following options to change the command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -94,7 +94,7 @@ Use the following options to change the command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -134,7 +134,7 @@ Use the following options to change the command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -166,7 +166,7 @@ List all environments.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ OPTIONS:
--address value The host and port (formatted as host:port) for the Temporal Frontend Service. [$TEMPORAL_CLI_ADDRESS]
--codec-auth value Sets the authorization header on requests to the Codec Server. [$TEMPORAL_CLI_CODEC_AUTH]
--codec-endpoint value Endpoint for a remote Codec Server. [$TEMPORAL_CLI_CODEC_ENDPOINT]
--context-timeout value An optional timeout for the context of an RPC call (in seconds). (default: 5) [$TEMPORAL_CONTEXT_TIMEOUT]
--command-timeout duration Timeout for the span of a command. (default 0s)
--env value Name of the environment to read environmental variables from. (default: "default")
--grpc-meta value [ --grpc-meta value ] Contains gRPC metadata to send with requests (format: key=value). Values must be in a valid JSON format.
--namespace value, -n value Identifies a Namespace in the Temporal Workflow. (default: "default") [$TEMPORAL_CLI_NAMESPACE]
Expand Down
38 changes: 24 additions & 14 deletions docs/cli/operator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Use the following options to change the output of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -123,7 +123,7 @@ Use the following options to change the behavior and output of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -159,7 +159,7 @@ Use the following options to change the command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -207,7 +207,7 @@ Use the following options to change the command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -246,7 +246,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -288,7 +288,7 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--enable-connection](/cli/cmd-options#enable-connection)

Expand Down Expand Up @@ -346,7 +346,7 @@ Use the options listed below to change the command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--data](/cli/cmd-options#data)

Expand Down Expand Up @@ -399,7 +399,7 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -438,7 +438,7 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -476,7 +476,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -531,7 +531,7 @@ Use the options listed below to change the command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--data](/cli/cmd-options#data)

Expand Down Expand Up @@ -620,6 +620,8 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--command-timeout](/cli/cmd-options#command-timeout)

- [--description](/cli/cmd-options#description)

- [--description-file](/cli/cmd-options#description-file)
Expand Down Expand Up @@ -688,6 +690,8 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

- [--env-file](/cli/cmd-options#env-file)
Expand Down Expand Up @@ -746,6 +750,8 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

- [--env-file](/cli/cmd-options#env-file)
Expand Down Expand Up @@ -804,6 +810,8 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

- [--env-file](/cli/cmd-options#env-file)
Expand Down Expand Up @@ -878,6 +886,8 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--command-timeout](/cli/cmd-options#command-timeout)

- [--description](/cli/cmd-options#description)

- [--description-file](/cli/cmd-options#description-file)
Expand Down Expand Up @@ -951,7 +961,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -991,7 +1001,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -1028,7 +1038,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down
16 changes: 8 additions & 8 deletions docs/cli/schedule.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--end-time](/cli/cmd-options#end-time)

Expand Down Expand Up @@ -155,7 +155,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--cron](/cli/cmd-options#cron)

Expand Down Expand Up @@ -243,7 +243,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -282,7 +282,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -329,7 +329,7 @@ Use the options below to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -382,7 +382,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -432,7 +432,7 @@ Use the following options to change this command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -487,7 +487,7 @@ Use the following options to change the command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--cron](/cli/cmd-options#cron)

Expand Down
8 changes: 4 additions & 4 deletions docs/cli/task-queue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Use the following options to change the behavior of this command.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -90,7 +90,7 @@ Use the following options to change the command's behavior.

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -126,7 +126,7 @@ Fetch the sets of compatible build IDs associated with a Task Queue and associat

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down Expand Up @@ -166,7 +166,7 @@ If a Task Queue isn't provided, reachability for the provided Build IDs is check

- [--color](/cli/cmd-options#color)

- [--context-timeout](/cli/cmd-options#context-timeout)
- [--command-timeout](/cli/cmd-options#command-timeout)

- [--env](/cli/cmd-options#env)

Expand Down
Loading