Skip to content

Commit da31f54

Browse files
drewhoskins-temporalbrianmacdonald-temporaldandavison
authored
Update with Start GA Docs (#3640)
* Update UwS docs to reflect GA * Pricing updates * PHP supports side effects * Tweak availability wording * Correct signal-with-start docs per Stephan * Remove Generally Available notices --------- Co-authored-by: Brian MacDonald <brian.macdonald@temporal.io> Co-authored-by: Dan Davison <dan.davison@temporal.io>
1 parent 331b9bd commit da31f54

7 files changed

Lines changed: 15 additions & 35 deletions

File tree

docs/develop/dotnet/message-passing.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -342,11 +342,9 @@ To send an Update to a Workflow Execution, you can:
342342

343343
#### Update-with-Start {#update-with-start}
344344

345-
:::tip Stability
346-
347-
In [Public Preview](/evaluate/development-production-features/release-stages#public-preview) in Temporal Cloud.
345+
:::tip
348346

349-
Minimum Temporal Server version [Temporal Server version 1.26](https://github.com/temporalio/temporal/releases/tag/v1.26.2)
347+
For open source server users, Temporal Server version [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) is recommended.
350348
351349
:::
352350

docs/develop/go/message-passing.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -377,11 +377,9 @@ if err != nil {
377377

378378
#### Update-With-Start {#update-with-start}
379379

380-
:::tip Stability
381-
382-
In [Public Preview](/evaluate/development-production-features/release-stages#public-preview) in Temporal Cloud.
380+
:::tip
383381

384-
Minimum Temporal Server version [Temporal Server version 1.26](https://github.com/temporalio/temporal/releases/tag/v1.26.2)
382+
For open source server users, Temporal Server version [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) is recommended.
385383

386384
:::
387385

docs/develop/java/message-passing.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -386,11 +386,9 @@ You can use the `WorkflowUpdateHandle` to obtain information about the update:
386386

387387
#### Update-With-Start {#update-with-start}
388388

389-
:::tip Stability
390-
391-
In [Public Preview](/evaluate/development-production-features/release-stages#public-preview) in Temporal Cloud.
389+
:::tip
392390

393-
Minimum Temporal Server version [Temporal Server version 1.26](https://github.com/temporalio/temporal/releases/tag/v1.26.2)
391+
For open source server users, Temporal Server version [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) is recommended.
394392

395393
:::
396394

docs/develop/python/message-passing.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -319,11 +319,9 @@ To obtain an Update handle, you can:
319319

320320
#### Update-With-Start {#update-with-start}
321321

322-
:::tip Stability
323-
324-
In [Public Preview](/evaluate/development-production-features/release-stages#public-preview) in Temporal Cloud.
322+
:::tip
325323

326-
Minimum Temporal Server version [Temporal Server version 1.26](https://github.com/temporalio/temporal/releases/tag/v1.26.2)
324+
For open source server users, Temporal Server version [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) is recommended.
327325

328326
:::
329327

docs/develop/typescript/message-passing.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -354,11 +354,9 @@ To obtain an Update handle, you can:
354354

355355
#### Update-With-Start {#update-with-start}
356356

357-
:::tip Stability
358-
359-
In [Public Preview](/evaluate/development-production-features/release-stages#public-preview) in Temporal Cloud.
357+
:::tip
360358

361-
Minimum Temporal Server version [Temporal Server version 1.26](https://github.com/temporalio/temporal/releases/tag/v1.26.2)
359+
For open source server users, Temporal Server version [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) is recommended.
362360

363361
:::
364362

docs/encyclopedia/workflow-message-passing/sending-messages.mdx

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -124,18 +124,9 @@ Use [Update Validators](/handling-messages#update-validators) and [Update IDs](/
124124

125125
#### Update-With-Start {#update-with-start}
126126

127-
:::tip Stability
127+
:::tip
128128

129-
In [Public Preview](/evaluate/development-production-features/release-stages#public-preview) in Temporal Cloud.
130-
131-
Minimum Temporal Server version [Temporal Server version 1.26](https://github.com/temporalio/temporal/releases/tag/v1.26.2)
132-
133-
- Available in [Go SDK](https://pkg.go.dev/go.temporal.io/sdk@v1.31.0/client#Client.UpdateWithStartWorkflow) since [v1.31.0](https://github.com/temporalio/sdk-go/releases/tag/v1.31.0)
134-
- Available in [Java SDK](https://www.javadoc.io/doc/io.temporal/temporal-sdk/1.27.0/io/temporal/client/WorkflowStub.html#startUpdateWithStart(io.temporal.client.UpdateOptions,java.lang.Object%5B%5D,java.lang.Object%5B%5D)) since [v1.27.0](https://github.com/temporalio/sdk-java/releases/tag/v1.27.0)
135-
- Available in [Python SDK](/develop/python/message-passing#send-update-from-client) since [v1.9.0](https://github.com/temporalio/sdk-python/releases/tag/1.9.0)
136-
- Available in [TypeScript SDK](https://typescript.temporal.io/api/interfaces/client.WorkflowHandle#executeupdate) since [v1.11.6](https://github.com/temporalio/sdk-typescript/releases/tag/v1.11.6)
137-
- Available in [PHP SDK](https://php.temporal.io/classes/Temporal-Client-WorkflowClient.html#method_updateWithStart) since [v2.11.4](https://github.com/temporalio/sdk-php/releases/tag/v2.11.4)
138-
- Available in [.NET SDK](https://dotnet.temporal.io/api/Temporalio.Client.WorkflowStartUpdateWithStartOptions.html) since [v1.4.0](https://github.com/temporalio/sdk-dotnet/releases/tag/1.4.0)
129+
For open source server users, Temporal Server version [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) is recommended.
139130

140131
:::
141132

docs/evaluate/temporal-cloud/actions.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The following result in an action on Temporal Cloud:
3030
## Workflows
3131

3232
- **Workflow started**.
33-
Occurs via client start, client [Signal-With-Start](/sending-messages#signal-with-start), [Continue-As-New](/workflow-execution/continue-as-new), or [Child Workflow](/child-workflows) start.
33+
Occurs via client start, [Continue-As-New](/workflow-execution/continue-as-new), [Child Workflow](/child-workflows) start. Also occurs with [Update-With-Start](/sending-messages#update-with-start) if the Workflow was not already started.
3434
If a Workflow start fails, an Action is not recorded.
3535
- **Workflow reset**.
3636
Occurs when a [Workflow](/workflows) is reset.
@@ -43,15 +43,14 @@ The following result in an action on Temporal Cloud:
4343
Search Attributes specified during Workflow start are _excluded_ from Action counts.
4444
The `TemporalChangeVersion` Search Attribute, used for Workflow versioning, is also exempt from Action counting.
4545
- **Signal sent**.
46-
An Action occurs for every [Signal](/sending-messages#sending-signals), whether sent from a Client or from a Workflow.
46+
An Action occurs for every [Signal](/sending-messages#sending-signals), whether sent from a Client or from a Workflow. Also, one total action occurs for any [Signal-With-Start](/sending-messages#signal-with-start), regardless of whether the Workflow starts.
4747
- **Query received by Worker**.
4848
An Action occurs for every [Query](/sending-messages#sending-queries), including viewing the call stack in the Temporal Cloud UI, which results in a Query behind the scenes.
4949
- **Update received by Worker**.
50-
An Action occurs for every successful [Update](/sending-messages#sending-updates) and every [rejected](/handling-messages#update-validators) Update.
50+
An Action occurs for every successful [Update](/sending-messages#sending-updates) and every [rejected](/handling-messages#update-validators) Update. This includes [Update-With-Start](/sending-messages#update-with-start), and is in addition to the start Action in the case when the Workflow starts as well.
5151
De-duplicated Updates that share an Update ID do _not_ count as an Action.
5252
- **Side Effect recorded**.
5353
For a mutable [Side Effect](/workflow-execution/event#side-effect), an Action occurs only when the value changes.
54-
(Be aware that only the Go and Java SDKs support Side Effects.)
5554

5655
## Child Workflows
5756

0 commit comments

Comments
 (0)