From 461785ef04f550035605a5b39bc151e64f082742 Mon Sep 17 00:00:00 2001
From: Alice Purcell <alicederyn@gmail.com>
Date: Wed, 2 Oct 2024 11:01:00 +0100
Subject: [PATCH] Document incremental migration option

Signed-off-by: Alice Purcell <alicederyn@gmail.com>
---
 docs/user-guides/decorators.md                | 37 +++++++++++++
 .../incremental-workflow-migration.yaml       | 53 +++++++++++++++++++
 .../incremental_workflow_migration.py         | 33 ++++++++++++
 3 files changed, 123 insertions(+)
 create mode 100644 examples/workflows/experimental/incremental-workflow-migration.yaml
 create mode 100644 examples/workflows/experimental/incremental_workflow_migration.py

diff --git a/docs/user-guides/decorators.md b/docs/user-guides/decorators.md
index 1526261a0..8e8559be6 100644
--- a/docs/user-guides/decorators.md
+++ b/docs/user-guides/decorators.md
@@ -170,3 +170,40 @@ We can simply call the script templates, passing the input objects in.
 
 For more complex examples, including use of a dag, see
 [the "experimental" examples](../examples/workflows/experimental/new_dag_decorator_params.md).
+
+## Incremental workflow migration
+
+If you have a larger workflow you want to migrate to decorator syntax, you can enable a hybrid mode where Pydantic types can be passed to functions in a Steps/DAG context block, intermixed with calls that pass dictionaries. This will allow you to make smaller changes, and verify that the generated YAML remains the same. For example:
+
+```py
+from hera.shared import global_config
+from hera.workflows import Input, Output, Steps, Workflow, script
+
+global_config.experimental_features["context_manager_pydantic_io"] = True
+
+class MyInput(Input):
+    value: int
+
+class MyOutput(Output):
+    value: int
+
+# Function migrated to Pydantic I/O
+@script()
+def double(input: MyInput) -> MyOutput:
+    return MyOutput(value = input.value * 2)
+
+# Not yet migrated to Pydantic I/O
+@script()
+def print_value(value: int) -> None:
+    print("Value was", value)
+
+# Not yet migrated to decorator syntax
+with Workflow(name="my-template") as w:
+    with Steps(name="steps"):
+        # Can now pass Pydantic types to/from functions
+        first_step = double(Input(value=5))
+        # Results can be passed into non-migrated functions
+        print_value(arguments={"value": first_step.value})
+```
+
+This feature is turned on by a different experimental flag, as we recommend only using this as a temporary stop-gap during a migration. Once you have fully migrated, you can disable the flag again to verify you are no longer using hybrid mode.
diff --git a/examples/workflows/experimental/incremental-workflow-migration.yaml b/examples/workflows/experimental/incremental-workflow-migration.yaml
new file mode 100644
index 000000000..9a5aa16bd
--- /dev/null
+++ b/examples/workflows/experimental/incremental-workflow-migration.yaml
@@ -0,0 +1,53 @@
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+  name: my-template
+spec:
+  templates:
+  - name: steps
+    steps:
+    - - name: double
+        template: double
+    - - arguments:
+          parameters:
+          - name: value
+            value: '{{steps.double.outputs.parameters.value}}'
+        name: print-value
+        template: print-value
+  - inputs:
+      parameters:
+      - name: value
+    name: double
+    outputs:
+      parameters:
+      - name: value
+    script:
+      command:
+      - python
+      image: python:3.9
+      source: |-
+        import os
+        import sys
+        sys.path.append(os.getcwd())
+        import json
+        try: value = json.loads(r'''{{inputs.parameters.value}}''')
+        except: value = r'''{{inputs.parameters.value}}'''
+
+        return MyOutput(value=input.value * 2)
+  - inputs:
+      parameters:
+      - name: value
+    name: print-value
+    script:
+      command:
+      - python
+      image: python:3.9
+      source: |-
+        import os
+        import sys
+        sys.path.append(os.getcwd())
+        import json
+        try: value = json.loads(r'''{{inputs.parameters.value}}''')
+        except: value = r'''{{inputs.parameters.value}}'''
+
+        print('Value was', value)
diff --git a/examples/workflows/experimental/incremental_workflow_migration.py b/examples/workflows/experimental/incremental_workflow_migration.py
new file mode 100644
index 000000000..a82359239
--- /dev/null
+++ b/examples/workflows/experimental/incremental_workflow_migration.py
@@ -0,0 +1,33 @@
+from hera.shared import global_config
+from hera.workflows import Input, Output, Steps, Workflow, script
+
+global_config.experimental_features["context_manager_pydantic_io"] = True
+
+
+class MyInput(Input):
+    value: int
+
+
+class MyOutput(Output):
+    value: int
+
+
+# Function migrated to Pydantic I/O
+@script()
+def double(input: MyInput) -> MyOutput:
+    return MyOutput(value=input.value * 2)
+
+
+# Not yet migrated to Pydantic I/O
+@script()
+def print_value(value: int) -> None:
+    print("Value was", value)
+
+
+# Not yet migrated to decorator syntax
+with Workflow(name="my-template") as w:
+    with Steps(name="steps"):
+        # Can now pass Pydantic types to/from functions
+        first_step = double(Input(value=5))
+        # Results can be passed into non-migrated functions
+        print_value(arguments={"value": first_step.value})