From 13a3202310805020a8d2f3ee84a787fd244ca282 Mon Sep 17 00:00:00 2001 From: Josh De Winne Date: Mon, 18 Dec 2023 16:54:35 -0800 Subject: [PATCH] WIP: multiline description --- create-cluster/README.md | 7 ++++++- create-cluster/action.yml | 4 +--- docs/generate-readme/action-to-mermaid.py | 2 +- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/create-cluster/README.md b/create-cluster/README.md index 034d60e..939fcf6 100644 --- a/create-cluster/README.md +++ b/create-cluster/README.md @@ -47,7 +47,12 @@ create_cluster ---> cluster_kubeconfig | nodes | | False | Number of nodes to provision | | instance-type | | False | Instance type to provision | | timeout-minutes | 20 | False | Time to wait for the cluster to have a status of `running` | -| tags | | False | Tags to assign to the cluster.
Example:
```
tags: \|
- key: "department"
value: "engineering"
```
| +| tags | | False | Tags to assign to the cluster. Example: ``` +tags: \| + - key: "department" + value: "engineering" +``` + | | kubeconfig-path | | False | If specified, the kubeconfig will be written to this path | | export-kubeconfig | false | False | Export the KUBECONFIG variable (true/false) | diff --git a/create-cluster/action.yml b/create-cluster/action.yml index 8e08f53..9acb9d4 100644 --- a/create-cluster/action.yml +++ b/create-cluster/action.yml @@ -33,9 +33,7 @@ inputs: default: '20' tags: description: | - Tags to assign to the cluster. - Example: - ``` + Tags to assign to the cluster. Example: ``` tags: \| - key: "department" value: "engineering" diff --git a/docs/generate-readme/action-to-mermaid.py b/docs/generate-readme/action-to-mermaid.py index e15beef..c111158 100644 --- a/docs/generate-readme/action-to-mermaid.py +++ b/docs/generate-readme/action-to-mermaid.py @@ -54,7 +54,7 @@ def generate_inputs(action_yaml_file): defaultVal = data['inputs'][input_name]['default'] if 'default' in data['inputs'][input_name] else "" requiredVal = data['inputs'][input_name]['required'] if 'required' in data['inputs'][input_name] else True descriptionVal = data['inputs'][input_name]['description'] if 'description' in data['inputs'][input_name] else "" - inputs += "| " + input_name + " | " + defaultVal + " | " + str(requiredVal) + " | " + descriptionVal.replace('\n','
') + " |\n" + inputs += "| " + input_name + " | " + defaultVal + " | " + str(requiredVal) + " | " + descriptionVal + " |\n" return inputs