Merge pull request #25365 from fidelity-contributions/issue-24968-update-input-examples

Updating template input documentation
2024-06-24 13:38:53 +02:00
parent 50dc650947 6e11898ea2
commit 4848c98258
1 changed files with 48 additions and 0 deletions
@@ -256,3 +256,51 @@ spec:
      input:
        url: ${{ '/root' if parameters.path !== true else parameters.path }}
 ```
+
+## 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 }}
+```