Skip to content

docs(parameters): fix parsed_params output examples - #508

Open
kakakakakku wants to merge 1 commit into
github:mainfrom
kakakakakku:docs-parameters
Open

kakakakakku wants to merge 1 commit into
github:mainfrom
kakakakakku:docs-parameters

Conversation

@kakakakakku

Copy link
Copy Markdown
Contributor

Hi😀 Thank you for creating such a great tool!

Summary

I recently discovered the parameters feature and tried it out by following the examples in docs/parameters.md. While testing, I noticed that the parsed_params values shown in the Outputs sections are slightly different from what the action actually returns. I tested with branch-deploy@v12.0.1.

Example 1

Run echo "params: ${PARAMS}"
params: LOG_LEVEL=debug,CPU_CORES=4
parsed_params: {"_":["LOG_LEVEL=debug,CPU_CORES=4"]}

Example 2

Run echo "params: ${PARAMS}"
params: something1 something2 something3
parsed_params: {"_":["something1","something2","something3"]}

Example 3

Run echo "params: ${PARAMS}"
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"}

Motivation

Since users will parse the received parameters in their workflows, I think having the outputs documented in the exact format they actually receive is friendlier for users.

Thanks!

Copilot AI balanced review requested due to automatic review settings October 2, 2026 23:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The examples now match the parser behavior and output serialization.

Review effort: Balanced
Findings: None

What changed in this PR

Corrects parameter documentation to match the action’s actual JSON-serialized parsed_params output.

Changes:

  • Adds the positional _ property to examples.
  • Uses valid compact JSON formatting.
File Description
docs/​parameters.md Corrects three parsed_params output examples.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants