Update models for 3.7 compatibility (#1519)

**Pull Request Checklist**
- [x] Fixes #1461, also fixes #1312
- [x] Tests added
- [x] Documentation/examples added
- [x] [Good commit messages](https://cbea.ms/git-commit/) and/or PR
title

**Description of PR**
* Update models by using `3.7.3` to generate code.
* Update examples that have changed and use the new fields
* Remove mappings to non-existent fields (`pod_priority` was removed)
* Changes to `scripts/spec.py` to avoid creating a cycle in the
dependency graph (for `dlqTrigger`, see 6bf1b80)

I don't think there are any backwards-incompatible changes in this PR,
except for if you are importing from
`hera.events.models.io.argoproj.events.v1alpha1` directly for Argo
Workflows models as it is now under
`hera.events.models.github.com.argoproj.argo_events.pkg.apis.events.v1alpha1`
-- users should be importing from `hera.events.models` instead.

---------

Signed-off-by: Elliot Gunton <[email protected]>

Author: elliotgunton

Makefile

@@ -1,4 +1,4 @@
-ARGO_WORKFLOWS_VERSION="3.6.2"
+ARGO_WORKFLOWS_VERSION=3.7.3
 OPENAPI_SPEC_URL="https://raw.githubusercontent.com/argoproj/argo-workflows/v$(ARGO_WORKFLOWS_VERSION)/api/openapi-spec/swagger.json"
 SPEC_PATH="$(shell pwd)/argo-workflows-$(ARGO_WORKFLOWS_VERSION).json"
 
@@ -56,6 +56,7 @@ test-cli:  ## Run cli tests for Hera
 
 .PHONY: workflows-models
 workflows-models: ## Generate the Workflows models portion of Argo Workflows
+	@rm -rf src/hera/workflows/models
 	@touch $(SPEC_PATH)
 	@poetry run python scripts/spec.py $(OPENAPI_SPEC_URL) $(SPEC_PATH)
 	@poetry run datamodel-codegen \
@@ -79,6 +80,7 @@ workflows-models: ## Generate the Workflows models portion of Argo Workflows
 
 .PHONY: events-models
 events-models: ## Generate the Events models portion of Argo Workflows
+	@rm -rf src/hera/events/models
 	@touch $(SPEC_PATH)
 	@poetry run python scripts/spec.py $(OPENAPI_SPEC_URL) $(SPEC_PATH)
 	@poetry run datamodel-codegen \

docs/api/events/models.md

@@ -2,7 +2,7 @@
 
 ## `hera.events.models`
 
-::: hera.events.models.io.argoproj.events.v1alpha1
+::: hera.events.models.github.com.argoproj.argo_events.pkg.apis.events.v1alpha1
     options:
         inherited_members: false
         show_source: false

docs/examples/workflows-examples.md

@@ -22,6 +22,7 @@ Explore the examples through the side bar!
 
 | Example |
 |---------|
+| [artifact-passing-explicit-plugin](https://github.com/argoproj/argo-workflows/blob/main/examples/artifact-passing-explicit-plugin.yaml) |
 | [cluster-workflow-template/clustertemplates](https://github.com/argoproj/argo-workflows/blob/main/examples/cluster-workflow-template/clustertemplates.yaml) |
 | [configmaps/simple-parameters-configmap](https://github.com/argoproj/argo-workflows/blob/main/examples/configmaps/simple-parameters-configmap.yaml) |
 | [cron-backfill](https://github.com/argoproj/argo-workflows/blob/main/examples/cron-backfill.yaml) |

docs/examples/workflows/upstream/loops_param_argument.md

@@ -56,6 +56,8 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
                 template="cat-os-release",
             )
         Container(
+            name="cat-os-release",
+            annotations={"workflows.argoproj.io/display-name": "os-{{inputs.parameters.image}}-{{inputs.parameters.tag}}"},
             inputs=Inputs(
                 parameters=[
                     Parameter(
@@ -66,7 +68,6 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
                     ),
                 ],
             ),
-            name="cat-os-release",
             args=["/etc/os-release"],
             command=["cat"],
             image="{{inputs.parameters.image}}:{{inputs.parameters.tag}}",
@@ -98,6 +99,9 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
           parameters:
           - name: os-list
       - name: cat-os-release
+        metadata:
+          annotations:
+            workflows.argoproj.io/display-name: os-{{inputs.parameters.image}}-{{inputs.parameters.tag}}
         container:
           image: '{{inputs.parameters.image}}:{{inputs.parameters.tag}}'
           args:

docs/examples/workflows/upstream/retry_backoff.md

@@ -5,26 +5,7 @@
 This example is a replication of an Argo Workflow example in Hera.
 The upstream example can be [found here](https://github.com/argoproj/argo-workflows/blob/main/examples/retry-backoff.yaml).
 
-# This example demonstrates the use of retry back offs
-apiVersion: argoproj.io/v1alpha1
-kind: Workflow
-metadata:
-  generateName: retry-backoff-
-spec:
-  entrypoint: retry-backoff
-  templates:
-  - name: retry-backoff
-    retryStrategy:
-      limit: "10"
-      backoff:
-        duration: "1"       # Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h"
-        factor: "2"
-        maxDuration: "1m" # Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h"
-    container:
-      image: python:alpine3.6
-      command: ["python", -c]
-      # fail with a 66% probability
-      args: ["import random; import sys; exit_code = random.choice([0, 1, 1]); sys.exit(exit_code)"]
+
 
 
 === "Hera"
@@ -52,6 +33,7 @@ spec:
                     duration="1",
                     factor="2",
                     max_duration="1m",
+                    cap="5",
                 ),
             ),
         )
@@ -78,6 +60,7 @@ spec:
         retryStrategy:
           limit: '10'
           backoff:
+            cap: '5'
             duration: '1'
             factor: '2'
             maxDuration: 1m

docs/examples/workflows/upstream/synchronization_db_mutex_tmpl_level.md

@@ -56,6 +56,7 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
                 mutexes=[
                     Mutex(
                         name="welcome",
+                        database=True,
                     )
                 ],
             ),
@@ -69,6 +70,7 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
                 mutexes=[
                     Mutex(
                         name="test",
+                        database=True,
                     )
                 ],
             ),
@@ -115,6 +117,7 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
         synchronization:
           mutexes:
           - name: welcome
+            database: true
       - name: acquire-lock-1
         container:
           image: alpine:latest
@@ -126,5 +129,6 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
         synchronization:
           mutexes:
           - name: test
+            database: true
     ```
 

docs/examples/workflows/upstream/synchronization_db_mutex_wf_level.md

@@ -23,6 +23,7 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
             mutexes=[
                 Mutex(
                     name="test",
+                    database=True,
                 )
             ],
         ),
@@ -55,5 +56,6 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
       synchronization:
         mutexes:
         - name: test
+          database: true
     ```
 

docs/examples/workflows/upstream/synchronization_db_tmpl_level.md

@@ -12,7 +12,7 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
 
     ```python linenums="1"
     from hera.workflows import Container, Step, Steps, Workflow
-    from hera.workflows.models import Arguments, Parameter, SemaphoreRef, Synchronization
+    from hera.workflows.models import Arguments, Parameter, SemaphoreRef, SyncDatabaseRef, Synchronization
 
     with Workflow(
         api_version="argoproj.io/v1alpha1",
@@ -39,7 +39,11 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
         Container(
             name="acquire-lock",
             synchronization=Synchronization(
-                semaphores=[SemaphoreRef()],
+                semaphores=[
+                    SemaphoreRef(
+                        database=SyncDatabaseRef(key="template"),
+                    )
+                ]
             ),
             args=["sleep 10; echo acquired lock"],
             command=["sh", "-c"],
@@ -76,6 +80,7 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
           - -c
         synchronization:
           semaphores:
-          - {}
+          - database:
+              key: template
     ```
 

docs/examples/workflows/upstream/synchronization_db_wf_level.md

@@ -12,15 +12,19 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
 
     ```python linenums="1"
     from hera.workflows import Container, Workflow
-    from hera.workflows.models import SemaphoreRef, Synchronization
+    from hera.workflows.models import SemaphoreRef, SyncDatabaseRef, Synchronization
 
     with Workflow(
         api_version="argoproj.io/v1alpha1",
         kind="Workflow",
         generate_name="synchronization-db-wf-level-",
         entrypoint="hello-world",
         synchronization=Synchronization(
-            semaphores=[SemaphoreRef()],
+            semaphores=[
+                SemaphoreRef(
+                    database=SyncDatabaseRef(key="workflow"),
+                )
+            ]
         ),
     ) as w:
         Container(
@@ -50,6 +54,7 @@ The upstream example can be [found here](https://github.com/argoproj/argo-workfl
           - echo
       synchronization:
         semaphores:
-        - {}
+        - database:
+            key: workflow
     ```
 

examples/workflows/upstream/artifact-passing-explicit-plugin.upstream.yaml

@@ -0,0 +1,52 @@
+# This example demonstrates the ability to pass artifacts
+# from one step to the next with an explicit artifact plugin
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+  generateName: artifact-passing-
+spec:
+  entrypoint: artifact-example
+  templates:
+  - name: artifact-example
+    steps:
+    - - name: generate-artifact
+        template: hello-world-to-file
+    - - name: consume-artifact
+        template: print-message-from-file
+        arguments:
+          artifacts:
+          - name: message
+            from: "{{steps.generate-artifact.outputs.artifacts.hello-art}}"
+
+  - name: hello-world-to-file
+    container:
+      image: busybox
+      command: [sh, -c]
+      args: ["sleep 1; echo hello world | tee /tmp/hello_world.txt"]
+    outputs:
+      artifacts:
+      - name: hello-art
+        path: /tmp/hello_world.txt
+        plugin:
+          name: test
+          configuration: |
+            bucket: my-bucket
+            endpoint: minio:9000
+            insecure: true
+            accessKeySecret:
+              name: my-minio-cred
+              key: accesskey
+            secretKeySecret:
+              name: my-minio-cred
+              key: secretkey
+          key: hi
+
+  - name: print-message-from-file
+    inputs:
+      artifacts:
+      - name: message
+        path: /tmp/message
+    container:
+      image: alpine:latest
+      command: [sh, -c]
+      args: ["cat /tmp/message"]