Skip to content

Commit 942ba67

Browse files
committed
docs(parameters): fix parsed_params output examples
1 parent 97edad0 commit 942ba67

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎docs/parameters.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Here are a few examples of how to pass in parameters to the `.deploy` command an
1717
**Outputs**:
1818

1919
- `params` = `LOG_LEVEL=debug,CPU_CORES=4`
20-
- `parsed_params` = `["LOG_LEVEL=debug,CPU_CORES=4"]`
20+
- `parsed_params` = `{"_":["LOG_LEVEL=debug,CPU_CORES=4"]}`
2121

2222
**Why**: A user might need to deploy to the development environment and tell subsequent workflow steps to use a `LOG_LEVEL` of `debug` and `CPU_CORES` of `4`.
2323

@@ -32,7 +32,7 @@ Here are a few examples of how to pass in parameters to the `.deploy` command an
3232
**Outputs**:
3333

3434
- `params` = `something1 something2 something3`
35-
- `parsed_params` = `["something1", "something2", "something3"]`
35+
- `parsed_params` = `{"_":["something1","something2","something3"]}`
3636

3737
**Why**: This example shows that the `params` output is just a string that can be literally anything your heart desires. It is up to the user to parse the string and use it in subsequent steps.
3838

@@ -47,7 +47,7 @@ Here are a few examples of how to pass in parameters to the `.deploy` command an
4747
**Outputs**:
4848

4949
- `params` = `--cpu=2 --memory=4G --env=development --port=8080 --name=my-app -q my-queue`
50-
- `parsed_params` = `{_: [], cpu: 2, memory: '4G', env: 'development', port: 8080, name: 'my-app', q: 'my-queue'}`
50+
- `parsed_params` = `{"_":[],"cpu":2,"memory":"4G","env":"development","port":8080,"name":"my-app","q":"my-queue"}`
5151

5252
**Why**: This example shows that by using structure within your params string like `--key=value`, they can be automatically parsed into a JSON object and saved as the `parsed_params` output. This can be useful for users that want to pass in a number of parameters to their deployment and have them automatically parsed and saved as a JSON object as an output of this Action. Having machine readable output can be quite useful for subsequent workflow steps.
5353

0 commit comments

Comments
 (0)