From 942ba67a78ffbad4b09e20fd66037d9a713569c2 Mon Sep 17 00:00:00 2001 From: kakakakakku Date: Sat, 3 Oct 2026 08:17:26 +0900 Subject: [PATCH] docs(parameters): fix parsed_params output examples --- docs/parameters.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/parameters.md b/docs/parameters.md index 73ac7ef6..011b4907 100644 --- a/docs/parameters.md +++ b/docs/parameters.md @@ -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`. @@ -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. @@ -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.