docs(copier): updates copier for final release

Author: Matt-Carre

scripts/checkyamlcompliance.py

@@ -24,12 +24,6 @@
         api_ver = False
     if "kind" in yamldata.keys():
         match yamldata["kind"]:
-            case "ClusterWorkflowTemplate":
-                clst_tmpt = True
-            case "Workflow":
-                clst_tmpt = True
-            case "WorkflowTemplate":
-                clst_tmpt = True
             case "ClusterWorkflowTemplate":
                 clst_tmpt = True
             case _:
@@ -38,7 +32,6 @@
         clst_tmpt = False
     if "metadata" in yamldata.keys():
         metadata = True
-        gen_name = "generateName" in yamldata["metadata"].keys()
         normal_name = "name" in yamldata["metadata"].keys()
         if "annotations" in yamldata["metadata"].keys():
             annotations = True
@@ -64,19 +57,14 @@
         else:
             group = labels = False
     else:
-        metadata = normal_name = gen_name = False
-    if all([api_ver, clst_tmpt, title, repo, group, annotations, labels]):
-        if gen_name != normal_name:
-            exit(0)
-        else:
-            print(
-                "generated_name and normal_name error, must have one of these not both"
-            )
-            exit(1)
+        metadata = normal_name = False
+    if all([api_ver, clst_tmpt, title, repo, group, annotations, labels, normal_name]):
+        exit(0)
     else:
         print(f"""
                 within file: {file}...
                 metadata present?: {metadata}
+                name present?: {normal_name}
                 annotations present?: {annotations}
                 labels present?: {labels}
                 api_ver present?: {api_ver}

src/copier_template/README.md.jinja

@@ -7,6 +7,11 @@
 
  Python alternative to creating and running argo workflows in the Data Analysis Platform
 
+Update pyproject.toml for the following use cases:
+ - Pyright linting
+ - Dependencies
+
+
 This is where you should write a short paragraph that describes what your module does,
 how it does it, and why people should use it.
 

src/copier_template/renovate.json.jinja

@@ -0,0 +1,41 @@
+{{% raw %}}
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ],
+  "lockFileMaintenance": {
+    "description": "Keep uv.lock up to date, merging if tests pass",
+    "enabled": true,
+    "automerge": true
+  },
+  "packageRules": [
+    {
+      "description": "Disable python version as that is managed by {{repo_name}}",
+      "matchManagers": [
+        "pyenv"
+      ],
+      "enabled": false
+    },
+    {
+      "description": "Disable github actions that are managed by {{repo_name}}",
+      "matchPackageNames": [
+        "actions/checkout",
+        "astral-sh/setup-uv",
+        "actions/upload-artifact",
+        "actions/download-artifact",
+        "softprops/action-gh-release",
+        "codecov/codecov-action",
+        "docker/setup-buildx-action",
+        "docker/login-action",
+        "docker/build-push-action",
+        "docker/metadata-action"
+      ],
+      "matchManagers": [
+        "github-actions"
+      ],
+      "enabled": false
+    }
+  ]
+}
+{{% endraw %}}

src/copier_template/scripts/checkyamlcompliance.py.jinja

@@ -26,10 +26,6 @@ for file in yamllist:
         match yamldata["kind"]:
             case "ClusterWorkflowTemplate":
                 clst_tmpt = True
-            case "Workflow":
-                clst_tmpt = True
-            case "WorkflowTemplate":
-                clst_tmpt = True
             case _:
                 clst_tmpt = False
     else:

src/copier_template/src/{{ project_name }}/templates/example_import_files.txt.jinja

@@ -1,6 +1,6 @@
 {% raw %}
 apiVersion: argoproj.io/v1alpha1
-kind: WorkflowTemplate
+kind: ClusterWorkflowTemplate
 metadata:
   name: hera-example-pandas
   annotations:
@@ -28,7 +28,7 @@ spec:
         archive:
           none: {}
     script:
-      image: ghcr.io/matt-carre/{% endraw %}{{repo_name}}{% raw %}-mounted-image:latest
+      image: ghcr.io/diamondlightsource/{% endraw %}{{repo_name}}{% raw %}-mounted-image:latest
       source: |-
         import os
         import sys

src/copier_template/src/{{ project_name }}/workflow_definitions/create_notebook_in_image.py.jinja

@@ -18,7 +18,7 @@ from hera.workflows.archive import NoneArchiveStrategy
 # and was created with the included dockerfile.
 global_config.set_class_defaults(  # pyright: ignore
     Script,
-    image="ghcr.io/matt-carre/python-interface-to-workflows-mounted-image:latest",
+    image="ghcr.io/diamondlightsource/python-interface-to-workflows-mounted-image:latest",
 )
 
 
@@ -89,7 +89,7 @@ with Workflow(
     # All of these are required aside from "workflows.argoproj.io/description".
     entrypoint="workflowentry",
     api_version="argoproj.io/v1alpha1",
-    kind="WorkflowTemplate",
+    kind="ClusterWorkflowTemplate",
     labels={"workflows.diamond.ac.uk/science-group-examples": "true"},
     annotations={
         "workflows.argoproj.io/title": "notebook.yaml remade via hera",

src/python_interface_to_workflows/templates/example_import_files.txt

@@ -1,5 +1,5 @@
 apiVersion: argoproj.io/v1alpha1
-kind: WorkflowTemplate
+kind: ClusterWorkflowTemplate
 metadata:
   name: hera-example-pandas
   annotations:
@@ -27,7 +27,7 @@ spec:
         archive:
           none: {}
     script:
-      image: ghcr.io/matt-carre/python-interface-to-workflows-mounted-image:latest
+      image: ghcr.io/diamondlightsource/python-interface-to-workflows-mounted-image:latest
       source: |-
         import os
         import sys

src/python_interface_to_workflows/workflow_definitions/create_notebook_in_image.py

@@ -17,7 +17,7 @@
 # and was created with the included dockerfile.
 global_config.set_class_defaults(  # pyright: ignore
     Script,
-    image="ghcr.io/matt-carre/python-interface-to-workflows-mounted-image:latest",
+    image="ghcr.io/diamondlightsource/python-interface-to-workflows-mounted-image:latest",
 )
 
 
@@ -88,7 +88,7 @@ def mount_files():
     # All of these are required aside from "workflows.argoproj.io/description".
     entrypoint="workflowentry",
     api_version="argoproj.io/v1alpha1",
-    kind="WorkflowTemplate",
+    kind="ClusterWorkflowTemplate",
     labels={"workflows.diamond.ac.uk/science-group-examples": "true"},
     annotations={
         "workflows.argoproj.io/title": "notebook.yaml remade via hera",