diff --git a/CHANGELOG.md b/CHANGELOG.md index c7993d59..ee354f33 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -32,6 +32,11 @@ to docs, or any other relevant information. payloads (e.g. compression, encryption, external storage), it is advised that you disable size enforcement by setting `disable_payload_error_limit: true` on the worker. +### Changed + +- User metadata fields (static_summary, static_details, current_details, activity summary, timer + summary) are no longer marked as experimental. + ## [v1.6.0] - 2026-07-16 ### Added diff --git a/temporalio/lib/temporalio/client.rb b/temporalio/lib/temporalio/client.rb index 6ecb3bfc..e5014082 100644 --- a/temporalio/lib/temporalio/client.rb +++ b/temporalio/lib/temporalio/client.rb @@ -287,11 +287,10 @@ def operator_service # @param id [String] Unique identifier for the workflow execution. # @param task_queue [String] Task queue to run the workflow on. # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear in - # CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental. + # CLI/UI. This can be in single-line Temporal markdown format. # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI. This can # be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow that cannot be - # updated. For details that can be updated, use {Workflow.current_details=} within the workflow. This is currently - # experimental. + # updated. For details that can be updated, use {Workflow.current_details=} within the workflow. # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and continue # as new. # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds. @@ -380,11 +379,10 @@ def start_workflow( # @param id [String] Unique identifier for the workflow execution. # @param task_queue [String] Task queue to run the workflow on. # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear in - # CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental. + # CLI/UI. This can be in single-line Temporal markdown format. # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI. This can # be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow that cannot be - # updated. For details that can be updated, use {Workflow.current_details=} within the workflow. This is currently - # experimental. + # updated. For details that can be updated, use {Workflow.current_details=} within the workflow. # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and continue # as new. # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds. diff --git a/temporalio/lib/temporalio/client/schedule.rb b/temporalio/lib/temporalio/client/schedule.rb index 9153c082..c05b958c 100644 --- a/temporalio/lib/temporalio/client/schedule.rb +++ b/temporalio/lib/temporalio/client/schedule.rb @@ -193,12 +193,11 @@ def _to_proto(data_converter) # @return [String] Task queue to run the workflow on. # @!attribute static_summary # @return [String, nil] Fixed single-line summary for this workflow execution that may appear in CLI/UI. - # This can be in single-line Temporal markdown format. This is currently experimental. + # This can be in single-line Temporal markdown format. # @!attribute static_details # @return [String, nil] Fixed details for this workflow execution that may appear in CLI/UI. This can be in # Temporal markdown format and can be multiple lines. This is a fixed value on the workflow that cannot be - # updated. For details that can be updated, use {Workflow.current_details=} within the workflow. This is - # currently experimental. + # updated. For details that can be updated, use {Workflow.current_details=} within the workflow. # @!attribute execution_timeout # @return [Float, nil] Total workflow execution timeout in seconds including retries and continue as new. # @!attribute run_timeout @@ -231,11 +230,11 @@ class << self # @param id [String] Unique identifier for the workflow execution. # @param task_queue [String] Task queue to run the workflow on. # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear - # in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental. + # in CLI/UI. This can be in single-line Temporal markdown format. # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI. # This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow # that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the - # workflow. This is currently experimental. + # workflow. # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and # continue as new. # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds. diff --git a/temporalio/lib/temporalio/client/workflow_execution.rb b/temporalio/lib/temporalio/client/workflow_execution.rb index 7f3d30d3..27169c63 100644 --- a/temporalio/lib/temporalio/client/workflow_execution.rb +++ b/temporalio/lib/temporalio/client/workflow_execution.rb @@ -96,12 +96,12 @@ def initialize(raw_description, data_converter) @data_converter = data_converter end - # @return [String, nil] Static summary configured on the workflow. This is currently experimental. + # @return [String, nil] Static summary configured on the workflow. def static_summary user_metadata.first end - # @return [String, nil] Static details configured on the workflow. This is currently experimental. + # @return [String, nil] Static details configured on the workflow. def static_details user_metadata.last end diff --git a/temporalio/lib/temporalio/workflow.rb b/temporalio/lib/temporalio/workflow.rb index dfa52f90..712e0929 100644 --- a/temporalio/lib/temporalio/workflow.rb +++ b/temporalio/lib/temporalio/workflow.rb @@ -68,7 +68,7 @@ def self.target_worker_deployment_version_changed? # Get current details for this workflow that may appear in UI/CLI. Unlike static details set at start, this value # can be updated throughout the life of the workflow. This can be in Temporal markdown format and can span multiple - # lines. This is currently experimental. + # lines. # # @return [String] Current details. Default is empty string. def self.current_details @@ -77,7 +77,7 @@ def self.current_details # Set current details for this workflow that may appear in UI/CLI. Unlike static details set at start, this value # can be updated throughout the life of the workflow. This can be in Temporal markdown format and can span multiple - # lines. This is currently experimental. + # lines. # # @param details [String] Current details. Can use empty string to unset. def self.current_details=(details) @@ -136,7 +136,7 @@ def self.deprecate_patch(patch_id) # @param args [Array] Arguments to the activity. # @param task_queue [String] Task queue to run the activity on. Defaults to the current workflow's task queue. # @param summary [String, nil] Single-line summary for this activity that may appear in CLI/UI. This can be in - # single-line Temporal markdown format. This is currently experimental. + # single-line Temporal markdown format. # @param schedule_to_close_timeout [Float, nil] Max amount of time the activity can take from first being scheduled # to being completed before it times out. This is inclusive of all retries. # @param schedule_to_start_timeout [Float, nil] Max amount of time the activity can take to be started from first @@ -235,7 +235,7 @@ def self.execute_child_workflow( # @param activity [Class, Symbol, String] Activity definition class or name. # @param args [Array] Arguments to the activity. # @param summary [String, nil] Single-line summary for this activity that may appear in CLI/UI. This can be in - # single-line Temporal markdown format. This is currently experimental. + # single-line Temporal markdown format. # @param schedule_to_close_timeout [Float, nil] Max amount of time the activity can take from first being scheduled # to being completed before it times out. This is inclusive of all retries. # @param schedule_to_start_timeout [Float, nil] Max amount of time the activity can take to be started from first @@ -393,7 +393,7 @@ def self.signal_handlers # value cannot be negative. Since Temporal timers are server-side, timer resolution may not end up as precise as # system timers. # @param summary [String, nil] A simple string identifying this timer that may be visible in UI/CLI. While it can be - # normal text, it is best to treat as a timer ID. This is currently experimental. + # normal text, it is best to treat as a timer ID. # @param cancellation [Cancellation] Cancellation for this timer. # @raise [Error::CanceledError] Sleep canceled. def self.sleep(duration, summary: nil, cancellation: Workflow.cancellation) @@ -407,11 +407,10 @@ def self.sleep(duration, summary: nil, cancellation: Workflow.cancellation) # @param id [String] Unique identifier for the workflow execution. Defaults to a new UUID from {random}. # @param task_queue [String] Task queue to run the workflow on. Defaults to the current workflow's task queue. # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear in - # CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental. + # CLI/UI. This can be in single-line Temporal markdown format. # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI. This can # be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow that cannot be - # updated. For details that can be updated, use {Workflow.current_details=} within the workflow. This is currently - # experimental. + # updated. For details that can be updated, use {Workflow.current_details=} within the workflow. # @param cancellation [Cancellation] Cancellation to apply to the child workflow. How cancellation is treated is # based on `cancellation_type`. This defaults to the workflow's cancellation. # @param cancellation_type [ChildWorkflowCancellationType] How the child workflow will react to cancellation. @@ -480,7 +479,7 @@ def self.storage # @param message [String] Message to use for timeout exception. Defaults to "execution expired" like # {::Timeout.timeout}. # @param summary [String] Timer summary for the timer created by this timeout. This is backed by {sleep} so see that - # method for details. This is currently experimental. + # method for details. # # @yield Block to run with a timeout. # @return [Object] The result of the block.