Skip to content

Commit 99210f3

Browse files
authored
Remove experimental notice on Update (#782)
1 parent cbd133b commit 99210f3

2 files changed

Lines changed: 23 additions & 33 deletions

File tree

temporalcli/commands.gen.go

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3049,7 +3049,7 @@ func NewTemporalWorkflowExecuteUpdateWithStartCommand(cctx *CommandContext, pare
30493049
s.Parent = parent
30503050
s.Command.DisableFlagsInUseLine = true
30513051
s.Command.Use = "execute-update-with-start [flags]"
3052-
s.Command.Short = "Send an Update and wait for it to complete (Experimental)"
3052+
s.Command.Short = "Send an Update-With-Start and wait for it to complete (Experimental)"
30533053
if hasHighlighting {
30543054
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to complete. If the Workflow Execution is not running, then a new workflow\nexecution is started and the update is sent.\n\nExperimental.\n\n\x1b[1mtemporal workflow execute-update-with-start \\\n --update-name YourUpdate \\\n --update-input '{\"update-key\": \"update-value\"}' \\\n --workflow-id YourWorkflowId \\\n --type YourWorkflowType \\\n --task-queue YourTaskQueue \\\n --id-conflict-policy Fail \\\n --input '{\"wf-key\": \"wf-value\"}'\x1b[0m"
30553055
} else {
@@ -3483,7 +3483,7 @@ func NewTemporalWorkflowStartUpdateWithStartCommand(cctx *CommandContext, parent
34833483
s.Parent = parent
34843484
s.Command.DisableFlagsInUseLine = true
34853485
s.Command.Use = "start-update-with-start [flags]"
3486-
s.Command.Short = "Send an Update and wait for it to be accepted or rejected (Experimental)"
3486+
s.Command.Short = "Send an Update-With-Start and wait for it to be accepted or rejected (Experimental)"
34873487
if hasHighlighting {
34883488
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to be accepted or rejected. If the Workflow Execution is not running, \nthen a new workflow execution is started and the update is sent.\n\nExperimental.\n\n\x1b[1mtemporal workflow start-update-with-start \\\n --update-name YourUpdate \\\n --update-input '{\"update-key\": \"update-value\"}' \\\n --update-wait-for-stage accepted \\\n --workflow-id YourWorkflowId \\\n --type YourWorkflowType \\\n --task-queue YourTaskQueue \\\n --id-conflict-policy Fail \\\n --input '{\"wf-key\": \"wf-value\"}'\x1b[0m"
34893489
} else {
@@ -3598,8 +3598,8 @@ func NewTemporalWorkflowUpdateCommand(cctx *CommandContext, parent *TemporalWork
35983598
var s TemporalWorkflowUpdateCommand
35993599
s.Parent = parent
36003600
s.Command.Use = "update"
3601-
s.Command.Short = "Updates (Experimental)"
3602-
s.Command.Long = "An Update is a synchronous call to a Workflow Execution that can change its\nstate, control its flow, and return a result.\n\nExperimental."
3601+
s.Command.Short = "Send and interact with Updates"
3602+
s.Command.Long = "An Update is a synchronous call to a Workflow Execution that can change its\nstate, control its flow, and return a result."
36033603
s.Command.Args = cobra.NoArgs
36043604
s.Command.AddCommand(&NewTemporalWorkflowUpdateDescribeCommand(cctx, &s).Command)
36053605
s.Command.AddCommand(&NewTemporalWorkflowUpdateExecuteCommand(cctx, &s).Command)
@@ -3619,11 +3619,11 @@ func NewTemporalWorkflowUpdateDescribeCommand(cctx *CommandContext, parent *Temp
36193619
s.Parent = parent
36203620
s.Command.DisableFlagsInUseLine = true
36213621
s.Command.Use = "describe [flags]"
3622-
s.Command.Short = "Obtain status info about a specific Update (Experimental)"
3622+
s.Command.Short = "Obtain status info about a specific Update"
36233623
if hasHighlighting {
3624-
s.Command.Long = "Given a Workflow Execution and an Update ID, return information about its current status, including\na result if it has finished.\n\nExperimental.\n\n\x1b[1mtemporal workflow update describe \\\n --workflow-id YourWorkflowId \\\n --update-id YourUpdateId\x1b[0m"
3624+
s.Command.Long = "Given a Workflow Execution and an Update ID, return information about its current status, including\na result if it has finished.\n\n\x1b[1mtemporal workflow update describe \\\n --workflow-id YourWorkflowId \\\n --update-id YourUpdateId\x1b[0m"
36253625
} else {
3626-
s.Command.Long = "Given a Workflow Execution and an Update ID, return information about its current status, including\na result if it has finished.\n\nExperimental.\n\n```\ntemporal workflow update describe \\\n --workflow-id YourWorkflowId \\\n --update-id YourUpdateId\n```"
3626+
s.Command.Long = "Given a Workflow Execution and an Update ID, return information about its current status, including\na result if it has finished.\n\n```\ntemporal workflow update describe \\\n --workflow-id YourWorkflowId \\\n --update-id YourUpdateId\n```"
36273627
}
36283628
s.Command.Args = cobra.NoArgs
36293629
s.UpdateTargetingOptions.buildFlags(cctx, s.Command.Flags())
@@ -3647,11 +3647,11 @@ func NewTemporalWorkflowUpdateExecuteCommand(cctx *CommandContext, parent *Tempo
36473647
s.Parent = parent
36483648
s.Command.DisableFlagsInUseLine = true
36493649
s.Command.Use = "execute [flags]"
3650-
s.Command.Short = "Send an Update and wait for it to complete (Experimental)"
3650+
s.Command.Short = "Send an Update and wait for it to complete"
36513651
if hasHighlighting {
3652-
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to complete or fail. You can also use this to wait for an existing\nupdate to complete, by submitting an existing update ID.\n\nExperimental.\n\n\x1b[1mtemporal workflow update execute \\\n --workflow-id YourWorkflowId \\\n --name YourUpdate \\\n --input '{\"some-key\": \"some-value\"}'\x1b[0m"
3652+
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to complete or fail. You can also use this to wait for an existing\nupdate to complete, by submitting an existing update ID.\n\n\x1b[1mtemporal workflow update execute \\\n --workflow-id YourWorkflowId \\\n --name YourUpdate \\\n --input '{\"some-key\": \"some-value\"}'\x1b[0m"
36533653
} else {
3654-
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to complete or fail. You can also use this to wait for an existing\nupdate to complete, by submitting an existing update ID.\n\nExperimental.\n\n```\ntemporal workflow update execute \\\n --workflow-id YourWorkflowId \\\n --name YourUpdate \\\n --input '{\"some-key\": \"some-value\"}'\n```"
3654+
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to complete or fail. You can also use this to wait for an existing\nupdate to complete, by submitting an existing update ID.\n\n```\ntemporal workflow update execute \\\n --workflow-id YourWorkflowId \\\n --name YourUpdate \\\n --input '{\"some-key\": \"some-value\"}'\n```"
36553655
}
36563656
s.Command.Args = cobra.NoArgs
36573657
s.UpdateStartingOptions.buildFlags(cctx, s.Command.Flags())
@@ -3678,11 +3678,11 @@ func NewTemporalWorkflowUpdateResultCommand(cctx *CommandContext, parent *Tempor
36783678
s.Parent = parent
36793679
s.Command.DisableFlagsInUseLine = true
36803680
s.Command.Use = "result [flags]"
3681-
s.Command.Short = "Wait for a specific Update to complete (Experimental)"
3681+
s.Command.Short = "Wait for a specific Update to complete"
36823682
if hasHighlighting {
3683-
s.Command.Long = "Given a Workflow Execution and an Update ID, wait for the Update to complete or fail and\nprint the result.\n\nExperimental.\n\n\x1b[1mtemporal workflow update result \\\n --workflow-id YourWorkflowId \\\n --update-id YourUpdateId\x1b[0m"
3683+
s.Command.Long = "Given a Workflow Execution and an Update ID, wait for the Update to complete or fail and\nprint the result.\n\n\x1b[1mtemporal workflow update result \\\n --workflow-id YourWorkflowId \\\n --update-id YourUpdateId\x1b[0m"
36843684
} else {
3685-
s.Command.Long = "Given a Workflow Execution and an Update ID, wait for the Update to complete or fail and\nprint the result.\n\nExperimental.\n\n```\ntemporal workflow update result \\\n --workflow-id YourWorkflowId \\\n --update-id YourUpdateId\n```"
3685+
s.Command.Long = "Given a Workflow Execution and an Update ID, wait for the Update to complete or fail and\nprint the result.\n\n```\ntemporal workflow update result \\\n --workflow-id YourWorkflowId \\\n --update-id YourUpdateId\n```"
36863686
}
36873687
s.Command.Args = cobra.NoArgs
36883688
s.UpdateTargetingOptions.buildFlags(cctx, s.Command.Flags())
@@ -3707,11 +3707,11 @@ func NewTemporalWorkflowUpdateStartCommand(cctx *CommandContext, parent *Tempora
37073707
s.Parent = parent
37083708
s.Command.DisableFlagsInUseLine = true
37093709
s.Command.Use = "start [flags]"
3710-
s.Command.Short = "Send an Update and wait for it to be accepted or rejected (Experimental)"
3710+
s.Command.Short = "Send an Update and wait for it to be accepted or rejected"
37113711
if hasHighlighting {
3712-
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to be accepted or rejected. You can subsequently wait for the update\nto complete by using \x1b[1mtemporal workflow update execute\x1b[0m.\n\nExperimental.\n\n\x1b[1mtemporal workflow update start \\\n --workflow-id YourWorkflowId \\\n --name YourUpdate \\\n --input '{\"some-key\": \"some-value\"}'\n --wait-for-stage accepted\x1b[0m"
3712+
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to be accepted or rejected. You can subsequently wait for the update\nto complete by using \x1b[1mtemporal workflow update execute\x1b[0m.\n\n\x1b[1mtemporal workflow update start \\\n --workflow-id YourWorkflowId \\\n --name YourUpdate \\\n --input '{\"some-key\": \"some-value\"}'\n --wait-for-stage accepted\x1b[0m"
37133713
} else {
3714-
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to be accepted or rejected. You can subsequently wait for the update\nto complete by using `temporal workflow update execute`.\n\nExperimental.\n\n```\ntemporal workflow update start \\\n --workflow-id YourWorkflowId \\\n --name YourUpdate \\\n --input '{\"some-key\": \"some-value\"}'\n --wait-for-stage accepted\n```"
3714+
s.Command.Long = "Send a message to a Workflow Execution to invoke an Update handler, and wait for\nthe update to be accepted or rejected. You can subsequently wait for the update\nto complete by using `temporal workflow update execute`.\n\n```\ntemporal workflow update start \\\n --workflow-id YourWorkflowId \\\n --name YourUpdate \\\n --input '{\"some-key\": \"some-value\"}'\n --wait-for-stage accepted\n```"
37153715
}
37163716
s.Command.Args = cobra.NoArgs
37173717
s.WaitForStage = NewStringEnum([]string{"accepted"}, "")

temporalcli/commandsgen/commands.yml

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3601,21 +3601,17 @@ commands:
36013601
- workflow-reference
36023602

36033603
- name: temporal workflow update
3604-
summary: Updates (Experimental)
3604+
summary: Send and interact with Updates
36053605
description: |
36063606
An Update is a synchronous call to a Workflow Execution that can change its
36073607
state, control its flow, and return a result.
36083608
3609-
Experimental.
3610-
36113609
- name: temporal workflow update describe
3612-
summary: Obtain status info about a specific Update (Experimental)
3610+
summary: Obtain status info about a specific Update
36133611
description: |
36143612
Given a Workflow Execution and an Update ID, return information about its current status, including
36153613
a result if it has finished.
36163614
3617-
Experimental.
3618-
36193615
```
36203616
temporal workflow update describe \
36213617
--workflow-id YourWorkflowId \
@@ -3625,14 +3621,12 @@ commands:
36253621
- update-targeting
36263622

36273623
- name: temporal workflow update execute
3628-
summary: Send an Update and wait for it to complete (Experimental)
3624+
summary: Send an Update and wait for it to complete
36293625
description: |
36303626
Send a message to a Workflow Execution to invoke an Update handler, and wait for
36313627
the update to complete or fail. You can also use this to wait for an existing
36323628
update to complete, by submitting an existing update ID.
36333629
3634-
Experimental.
3635-
36363630
```
36373631
temporal workflow update execute \
36383632
--workflow-id YourWorkflowId \
@@ -3644,13 +3638,11 @@ commands:
36443638
- payload-input
36453639

36463640
- name: temporal workflow update result
3647-
summary: Wait for a specific Update to complete (Experimental)
3641+
summary: Wait for a specific Update to complete
36483642
description: |
36493643
Given a Workflow Execution and an Update ID, wait for the Update to complete or fail and
36503644
print the result.
36513645
3652-
Experimental.
3653-
36543646
```
36553647
temporal workflow update result \
36563648
--workflow-id YourWorkflowId \
@@ -3660,14 +3652,12 @@ commands:
36603652
- update-targeting
36613653

36623654
- name: temporal workflow update start
3663-
summary: Send an Update and wait for it to be accepted or rejected (Experimental)
3655+
summary: Send an Update and wait for it to be accepted or rejected
36643656
description: |
36653657
Send a message to a Workflow Execution to invoke an Update handler, and wait for
36663658
the update to be accepted or rejected. You can subsequently wait for the update
36673659
to complete by using `temporal workflow update execute`.
36683660
3669-
Experimental.
3670-
36713661
```
36723662
temporal workflow update start \
36733663
--workflow-id YourWorkflowId \
@@ -3690,7 +3680,7 @@ commands:
36903680
required: true
36913681

36923682
- name: temporal workflow start-update-with-start
3693-
summary: Send an Update and wait for it to be accepted or rejected (Experimental)
3683+
summary: Send an Update-With-Start and wait for it to be accepted or rejected (Experimental)
36943684
description: |
36953685
Send a message to a Workflow Execution to invoke an Update handler, and wait for
36963686
the update to be accepted or rejected. If the Workflow Execution is not running,
@@ -3773,7 +3763,7 @@ commands:
37733763
Assume update inputs are base64-encoded and attempt to decode them.
37743764
37753765
- name: temporal workflow execute-update-with-start
3776-
summary: Send an Update and wait for it to complete (Experimental)
3766+
summary: Send an Update-With-Start and wait for it to complete (Experimental)
37773767
description: |
37783768
Send a message to a Workflow Execution to invoke an Update handler, and wait for
37793769
the update to complete. If the Workflow Execution is not running, then a new workflow

0 commit comments

Comments
 (0)