improve readme

cli/classes/generated/definitions.py

@@ -156,7 +156,7 @@ class PlatformAction(BaseModel):
         extra='forbid',
     )
     name: str = Field(..., description='The name of the action.', examples=['rust-exercise-jobs'])
-    file: Optional[str] = Field(None, description='The file of the platform action. Written in Python')
+    code: str = Field(..., description='The file of the platform action. Written in Python')
     parameters: Optional[Parameters] = None
     function: Optional[constr(pattern=r'^[a-zA-Z0-9._-]+$')] = Field(
         'run', description='The function of the platform action.', examples=['run']
@@ -167,7 +167,7 @@ class PlatformAction(BaseModel):
         title='Exclude during',
     )
     environment: Optional[Environment] = Field(None, description='Environment variables for this platform action.')
-    platform: Optional[Target] = Field(None, description='Ignored for this action.')
+    platform: Target = Field(..., description='Ignored for this action.')
     kind: Optional[str] = Field(None, description='The kind of the platform action.', examples=['junit'])
     docker: Optional[Docker] = Field(None, description='The docker configuration that is used to execute the action')
     runAlways: Optional[bool] = Field(

cli/classes/merger.py

@@ -278,11 +278,12 @@ def traverse_external_actions(
                         typing.List[Action],
                     ]
                 ] = None
-                if isinstance(action, (PlatformAction, FileAction)):
+                if isinstance(action, FileAction):
                     path = action.file
-                    if isinstance(action, PlatformAction):
-                        if path is None:
-                            converted = ([name], [Action(root=action)])
+                elif isinstance(action, PlatformAction):
+                    path = action.code
+                    if path is None:
+                        converted = ([name], [Action(root=action)])
                 elif isinstance(action, TemplateAction):
                     path = action.use
                 if path:
@@ -309,6 +310,7 @@ def traverse_external_actions(
                 logger.error("❌", f"{exception}", self.output_settings.emoji)
                 if self.output_settings.debug:
                     traceback.print_exc()
+                return False
         return True
 
     def inline_actions(

cli/examples/example-windfile-readme.yml

@@ -7,29 +7,15 @@ metadata:
   docker:
     image: ls1tum/artemis-maven-template
     tag: java17-20
-    volumes:
-      - ${WORKDIR}:/aeolus
-  gitCredentials: artemis_gitlab_admin_credentials
 repositories:
   aeolus:
     url: https://github.com/ls1intum/Aeolus.git
     branch: develop
     path: aeolus
 actions:
-  - name: set-java-container
-    script: set
-  - name: set-c-container
-    docker:
-      image: ghcr.io/ls1intum/artemis-c-docker
-    script: set
-  - name: internal-action
-    script: |
-      echo "This is an internal action"
-  - name: external-action
-    use: simple-action.yml
-    excludeDuring:
-      - working_time
-  - name: clean_up
-    script: |
-      rm -rf aeolus/
-    runAlways: true
+  - name: script-action
+    script: echo "I am a script action"
+  - name: template-action
+    use: https://github.com/reschandreas/example-action.git
+    parameters:
+      WHO_TO_GREET: "hello"

cli/examples/windfiles/windfile-with-platform-action.yml

@@ -5,4 +5,5 @@ metadata:
   author: Andreas Resch
 actions:
   - name: hello-world
-    use: ../actions/platform-action.yml
+    platform: bamboo
+    code: install-api.py

schemas/v0.0.1/schemas/definitions.json

@@ -201,7 +201,7 @@
           "rust-exercise-jobs"
         ]
       },
-      "file": {
+      "code": {
         "description": "The file of the platform action. Written in Python",
         "type": "string"
       },
@@ -265,15 +265,9 @@
       }
     },
     "required": [
-      "name"
-    ],
-    "oneOff": [
-      {
-        "required": [
-          "for",
-          "file"
-        ]
-      }
+      "code",
+      "name",
+      "platform"
     ]
   },
   "file-action": {