Skip to content

Commit 393ccc4

Browse files
authored
Fix typo and add FAQ
1 parent facf4b0 commit 393ccc4

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -513,9 +513,9 @@ logger := activity.Logger(ctx)
513513
514514
The returned `logger` implements the `Logger` interface, and already has the id of the activity, and the workflow instance and execution IDs set as default fields.
515515
516-
## Versioning
516+
## Workflow Versioning
517517
518-
For now, I've intentionally left our versioning. Cadence, Temporal, and DTFx all support the concept of versions for workflows as well as activities. This is mostly required when you make changes to workflows and need to keep backwards compatibility with workflows that are being executed at the time of the upgrade.
518+
For now, I've intentionally left out versioning. Cadence, Temporal, and DTFx all support the concept of versions for workflows as well as activities. This is mostly required when you make changes to workflows and need to keep backwards compatibility with workflows that are being executed at the time of the upgrade.
519519

520520
**Example**: when you change a workflow from:
521521

@@ -576,4 +576,10 @@ This kind of check is understandable for simple changes, but it becomes hard and
576576
577577
## `ContinueAsNew`
578578
579-
Both Temporal/Cadence and DTFx support `ContinueAsNew`. This essentially re-starts a running workflow as a new workflow with a new event history. This is needed for long running workflows where the history can become very large, negatively affecting performance. While `WorkflowInstance` supports an `InstanceID` and an `ExecutionID`, this feature is not yet implemented (and might not be).
579+
Both Temporal/Cadence and DTFx support `ContinueAsNew`. This essentially re-starts a running workflow as a new workflow with a new event history. This is needed for long running workflows where the history can become very large, negatively affecting performance. While `WorkflowInstance` supports an `InstanceID` and an `ExecutionID`, this feature is not yet implemented (and might not be).
580+
581+
## FAQ
582+
583+
### How are releases versioned?
584+
585+
For now this library is in a pre-release state. There are no guarantees given regarding breaking changes between (pre)-releases.

0 commit comments

Comments
 (0)