Updating template input documentation

Signed-off-by: Tavi Nolan <Tavi.Nolan@fmr.com>
2024-06-06 14:56:30 +01:00
parent dadc9960f9
commit 6e11898ea2
1 changed files with 48 additions and 0 deletions
@@ -238,3 +238,51 @@ spec:
      input:
        url: ${{ parameters.path if parameters.path else '/root' }}
 ```
+
+## Use placeholders to reference remote files
+
+#### Note: testing of this functionality is not yet supported using _create/edit_
+
+### template.yaml
+
+```yaml
+spec:
+  parameters:
+    - $yaml: https://github.com/example/path/to/example.yaml
+    - title: Fill in some steps
+      properties:
+        path:
+          title: path
+          type: string
+
+  steps:
+    - $yaml: https://github.com//example/path/to/action.yaml
+
+    - id: fetch
+      name: Fetch template
+      action: fetch:template
+      input:
+        url: ${{ parameters.path if parameters.path else '/root' }}
+```
+
+### example.yaml
+
+```yaml
+title: Provide simple information
+required:
+  - url
+properties:
+  url:
+    title: url
+    type: string
+```
+
+### action.yaml
+
+```yaml
+id: publish
+name: Publish files
+action: publish:github
+input:
+  repoUrl: ${{ parameters.url }}
+```