Skip to content

docs(parameters): fix parsed_params output examples #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kakakakakku wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(parameters): fix parsed_params output examples #508

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Here are a few examples of how to pass in parameters to the `.deploy` command an
**Outputs**:

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

**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`.

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

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

**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.

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

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

**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.

Expand Down