docs: Specify default VersioningIntent (#1278)

Author: lorensr

packages/common/src/activity-options.ts

@@ -106,6 +106,8 @@ export interface ActivityOptions {
    * When using the Worker Versioning feature, specifies whether this Activity should run on a
    * worker with a compatible Build Id or not. See {@link VersioningIntent}.
    *
+   * @default 'COMPATIBLE'
+   *
    * @experimental
    */
   versioningIntent?: VersioningIntent;

packages/common/src/versioning-intent.ts

@@ -1,17 +1,15 @@
 /**
- * Indicates whether the user intends certain commands to be run on a compatible worker Build Id
- * version or not.
+ * Indicates whether the user intends certain commands to be run on a compatible worker Build Id version or not.
  *
- * `COMPATIBLE` indicates that the command should run on a worker with compatible version if
- * possible. It may not be possible if the target task queue does not also have knowledge of the
- * current worker's Build Id.
+ * `COMPATIBLE` indicates that the command should run on a worker with compatible version if possible. It may not be
+ * possible if the target task queue does not also have knowledge of the current worker's Build Id.
  *
- * `DEFAULT` indicates that the command should run on the target task queue's current
- * overall-default Build Id.
+ * `DEFAULT` indicates that the command should run on the target task queue's current overall-default Build Id.
  *
- * Where this type is accepted optionally, an unset value indicates that the SDK should choose the
- * most sensible default behavior for the type of command, accounting for whether the command will
- * be run on the same task queue as the current worker.
+ * Where this type is accepted optionally, an unset value indicates that the SDK should choose the most sensible default
+ * behavior for the type of command, accounting for whether the command will be run on the same task queue as the
+ * current worker. The default behavior for starting Workflows is `DEFAULT`. The default behavior for Workflows starting
+ * Activities, starting Child Workflows, or Continuing As New is `COMPATIBLE`.
  *
  * @experimental
  */

packages/workflow/src/interfaces.ts

@@ -231,6 +231,8 @@ export interface ContinueAsNewOptions {
    * When using the Worker Versioning feature, specifies whether this Workflow should
    * Continue-as-New onto a worker with a compatible Build Id or not. See {@link VersioningIntent}.
    *
+   * @default 'COMPATIBLE'
+   *
    * @experimental
    */
   versioningIntent?: VersioningIntent;
@@ -341,6 +343,8 @@ export interface ChildWorkflowOptions extends CommonWorkflowOptions {
    * When using the Worker Versioning feature, specifies whether this Child Workflow should run on
    * a worker with a compatible Build Id or not. See {@link VersioningIntent}.
    *
+   * @default 'COMPATIBLE'
+   *
    * @experimental
    */
   versioningIntent?: VersioningIntent;