all inheritance decisions on producer

Author: carlydf

openapi/openapiv2.json

@@ -7190,26 +7190,6 @@
       },
       "description": "RequestIdReference is a indirect reference to a history event through the request ID."
     },
-    "WorkflowExecutionStartedEventAttributesSourceWorkflowVersioningInfo": {
-      "type": "object",
-      "properties": {
-        "deploymentVersion": {
-          "$ref": "#/definitions/v1WorkerDeploymentVersion"
-        },
-        "behavior": {
-          "$ref": "#/definitions/v1VersioningBehavior",
-          "description": "Base versioning behavior of source workflow."
-        },
-        "taskQueue": {
-          "type": "string",
-          "description": "Task queue name of source workflow if different from started workflow."
-        },
-        "pinnedOverride": {
-          "$ref": "#/definitions/v1VersioningOverride",
-          "description": "Override of source workflow if that override is pinned.\nPinned overrides are automatically inherited by child workflows,\ncontinue-as-new workflows, workflow retries, and cron workflows."
-        }
-      }
-    },
     "WorkflowRuleActionActionActivityPause": {
       "type": "object"
     },
@@ -15611,7 +15591,7 @@
         },
         "versioningOverride": {
           "$ref": "#/definitions/v1VersioningOverride",
-          "description": "Versioning override applied to this workflow when it was started."
+          "description": "Versioning override applied to this workflow when it was started.\nChildren, crons, retries, and continue-as-new will inherit source run's override if pinned\nand if the new workflow's Task Queue belongs to the override version."
         },
         "parentPinnedWorkerDeploymentVersion": {
           "type": "string",
@@ -15621,13 +15601,9 @@
           "$ref": "#/definitions/v1Priority",
           "title": "Priority metadata"
         },
-        "previousRunVersioningInfo": {
-          "$ref": "#/definitions/WorkflowExecutionStartedEventAttributesSourceWorkflowVersioningInfo",
-          "description": "When present, this workflow is part of a retry and/or ContinueAsNew chain, and the previous run in the\nchain was versioned. The `initiator` field of this event specifies why this new workflow was initiated.\nIf present, and the previous run's base behavior is PINNED, and the new run's Task Queue belongs\nto the previous run's Version, the new run will inherit the previous run's Version.\n\nIf initiated by a workflow ContinueAsNew, always populate.\n\nIf initiated by a workflow Cron, never populate, because new cron workflows should start their own version chain.\n\nIf initiated by a workflow retry, pass the retried run's `previous_run_versioning_info`, because a retry of a\nroot workflow or Cron workflow should not inherit the Pinned Version, but if the retried workflow has a PINNED\nparent or is part of a Pinned continue-as-new chain, the the new workflow should inherit the version of the\nexisting tree or chain.\n\nIf a versioning override is present, it will take precedence over the inherited base version."
-        },
-        "parentVersioningInfo": {
-          "$ref": "#/definitions/WorkflowExecutionStartedEventAttributesSourceWorkflowVersioningInfo",
-          "description": "When present, this is a child workflow of a versioned parent.\nIf the parent's base behavior is PINNED, and the child's Task Queue belongs to the\nparent's Version, the child workflow will inherit the parent's Version.\n\nIf `versioning_override` is present, it will take precedence over the inherited base version.\nIf `previous_run_versioning_info` is present, it will take precedence over `parent_versioning_info`."
+        "inheritedPinnedVersion": {
+          "$ref": "#/definitions/v1WorkerDeploymentVersion",
+          "description": "If present, the new workflow should start on this version with pinned base behavior.\nChild of pinned parent will inherit the parent's version if the Child's Task Queue belongs to that version.\n\nNew run initiated by workflow ContinueAsNew of pinned run, will inherit the previous run's version if the\nnew run's Task Queue belongs to that version.\n\nNew run initiated by workflow Cron will never inherit.\n\nNew run initiated by workflow Retry will only inherit if the retried run is effectively pinned at the time\nof retry, and the retried run inherited a pinned version when it started (ie. it is a child of a pinned\nparent, or a CaN of a pinned run, and is running on a Task Queue in the inherited version).\n\nPinned override is inherited if Task Queue of new run is compatible with the override version.\nOverride is inherited separately and takes precedence over inherited base version."
         }
       },
       "title": "Always the first event in workflow history"

openapi/openapiv3.yaml

@@ -13133,7 +13133,10 @@ components:
         versioningOverride:
           allOf:
             - $ref: '#/components/schemas/VersioningOverride'
-          description: Versioning override applied to this workflow when it was started.
+          description: |-
+            Versioning override applied to this workflow when it was started.
+             Children, crons, retries, and continue-as-new will inherit source run's override if pinned
+             and if the new workflow's Task Queue belongs to the override version.
         parentPinnedWorkerDeploymentVersion:
           type: string
           description: |-
@@ -13147,59 +13150,25 @@ components:
           allOf:
             - $ref: '#/components/schemas/Priority'
           description: Priority metadata
-        previousRunVersioningInfo:
+        inheritedPinnedVersion:
           allOf:
-            - $ref: '#/components/schemas/WorkflowExecutionStartedEventAttributes_SourceWorkflowVersioningInfo'
+            - $ref: '#/components/schemas/WorkerDeploymentVersion'
           description: |-
-            When present, this workflow is part of a retry and/or ContinueAsNew chain, and the previous run in the
-             chain was versioned. The `initiator` field of this event specifies why this new workflow was initiated.
-             If present, and the previous run's base behavior is PINNED, and the new run's Task Queue belongs
-             to the previous run's Version, the new run will inherit the previous run's Version.
-
-             If initiated by a workflow ContinueAsNew, always populate.
+            If present, the new workflow should start on this version with pinned base behavior.
+             Child of pinned parent will inherit the parent's version if the Child's Task Queue belongs to that version.
 
-             If initiated by a workflow Cron, never populate, because new cron workflows should start their own version chain.
+             New run initiated by workflow ContinueAsNew of pinned run, will inherit the previous run's version if the
+             new run's Task Queue belongs to that version.
 
-             If initiated by a workflow retry, pass the retried run's `previous_run_versioning_info`, because a retry of a
-             root workflow or Cron workflow should not inherit the Pinned Version, but if the retried workflow has a PINNED
-             parent or is part of a Pinned continue-as-new chain, the the new workflow should inherit the version of the
-             existing tree or chain.
+             New run initiated by workflow Cron will never inherit.
 
-             If a versioning override is present, it will take precedence over the inherited base version.
-        parentVersioningInfo:
-          allOf:
-            - $ref: '#/components/schemas/WorkflowExecutionStartedEventAttributes_SourceWorkflowVersioningInfo'
-          description: |-
-            When present, this is a child workflow of a versioned parent.
-             If the parent's base behavior is PINNED, and the child's Task Queue belongs to the
-             parent's Version, the child workflow will inherit the parent's Version.
+             New run initiated by workflow Retry will only inherit if the retried run is effectively pinned at the time
+             of retry, and the retried run inherited a pinned version when it started (ie. it is a child of a pinned
+             parent, or a CaN of a pinned run, and is running on a Task Queue in the inherited version).
 
-             If `versioning_override` is present, it will take precedence over the inherited base version.
-             If `previous_run_versioning_info` is present, it will take precedence over `parent_versioning_info`.
+             Pinned override is inherited if Task Queue of new run is compatible with the override version.
+             Override is inherited separately and takes precedence over inherited base version.
       description: Always the first event in workflow history
-    WorkflowExecutionStartedEventAttributes_SourceWorkflowVersioningInfo:
-      type: object
-      properties:
-        deploymentVersion:
-          $ref: '#/components/schemas/WorkerDeploymentVersion'
-        behavior:
-          enum:
-            - VERSIONING_BEHAVIOR_UNSPECIFIED
-            - VERSIONING_BEHAVIOR_PINNED
-            - VERSIONING_BEHAVIOR_AUTO_UPGRADE
-          type: string
-          description: Base versioning behavior of source workflow.
-          format: enum
-        taskQueue:
-          type: string
-          description: Task queue name of source workflow if different from started workflow.
-        pinnedOverride:
-          allOf:
-            - $ref: '#/components/schemas/VersioningOverride'
-          description: |-
-            Override of source workflow if that override is pinned.
-             Pinned overrides are automatically inherited by child workflows,
-             continue-as-new workflows, workflow retries, and cron workflows.
     WorkflowExecutionTerminatedEventAttributes:
       type: object
       properties:

temporal/api/history/v1/message.proto

@@ -119,6 +119,8 @@ message WorkflowExecutionStartedEventAttributes {
     // Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
     string inherited_build_id = 32 [deprecated = true];
     // Versioning override applied to this workflow when it was started.
+    // Children, crons, retries, and continue-as-new will inherit source run's override if pinned
+    // and if the new workflow's Task Queue belongs to the override version.
     temporal.api.workflow.v1.VersioningOverride versioning_override = 33;
     // When present, it means this is a child workflow of a parent that is Pinned to this Worker
     // Deployment Version. In this case, child workflow will start as Pinned to this Version instead
@@ -134,42 +136,21 @@ message WorkflowExecutionStartedEventAttributes {
     reserved 36;
     reserved "parent_pinned_deployment_version";
 
-    // When present, this workflow is part of a retry and/or ContinueAsNew chain, and the previous run in the
-    // chain was versioned. The `initiator` field of this event specifies why this new workflow was initiated.
-    // If present, and the previous run's base behavior is PINNED, and the new run's Task Queue belongs
-    // to the previous run's Version, the new run will inherit the previous run's Version.
+    // If present, the new workflow should start on this version with pinned base behavior.
+    // Child of pinned parent will inherit the parent's version if the Child's Task Queue belongs to that version.
     //
-    // If initiated by a workflow ContinueAsNew, always populate.
+    // New run initiated by workflow ContinueAsNew of pinned run, will inherit the previous run's version if the
+    // new run's Task Queue belongs to that version.
     //
-    // If initiated by a workflow Cron, never populate, because new cron workflows should start their own version chain.
+    // New run initiated by workflow Cron will never inherit.
     //
-    // If initiated by a workflow retry, pass the retried run's `previous_run_versioning_info`, because a retry of a
-    // root workflow or Cron workflow should not inherit the Pinned Version, but if the retried workflow has a PINNED
-    // parent or is part of a Pinned continue-as-new chain, the the new workflow should inherit the version of the
-    // existing tree or chain.
+    // New run initiated by workflow Retry will only inherit if the retried run is effectively pinned at the time
+    // of retry, and the retried run inherited a pinned version when it started (ie. it is a child of a pinned
+    // parent, or a CaN of a pinned run, and is running on a Task Queue in the inherited version).
     //
-    // If a versioning override is present, it will take precedence over the inherited base version.
-    SourceWorkflowVersioningInfo previous_run_versioning_info = 37;
-
-    // When present, this is a child workflow of a versioned parent.
-    // If the parent's base behavior is PINNED, and the child's Task Queue belongs to the
-    // parent's Version, the child workflow will inherit the parent's Version.
-    //
-    // If `versioning_override` is present, it will take precedence over the inherited base version.
-    // If `previous_run_versioning_info` is present, it will take precedence over `parent_versioning_info`.
-    SourceWorkflowVersioningInfo parent_versioning_info = 38;
-
-    message SourceWorkflowVersioningInfo {
-        temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 1;
-        // Base versioning behavior of source workflow.
-        temporal.api.enums.v1.VersioningBehavior behavior = 2;
-        // Task queue name of source workflow if different from started workflow.
-        string task_queue = 3;
-        // Override of source workflow if that override is pinned.
-        // Pinned overrides are automatically inherited by child workflows,
-        // continue-as-new workflows, workflow retries, and cron workflows.
-        temporal.api.workflow.v1.VersioningOverride pinned_override = 4;
-    }
+    // Pinned override is inherited if Task Queue of new run is compatible with the override version.
+    // Override is inherited separately and takes precedence over inherited base version.
+    temporal.api.deployment.v1.WorkerDeploymentVersion inherited_pinned_version = 37;
 }
 
 message WorkflowExecutionCompletedEventAttributes {