diff --git a/README.md b/README.md index ff152b0..80005ca 100644 --- a/README.md +++ b/README.md @@ -149,6 +149,7 @@ Variables substituted via `envsubst` at runtime: | `path_to_claude_code_executable` | Optional path to custom Claude Code executable. WARNING: May cause issues if outdated | - | | `path_to_bun_executable` | Optional path to custom Bun executable. WARNING: May cause issues if incompatible | - | | `show_full_output` | Show full JSON output. WARNING: May expose secrets in public logs | `false` | +| `display_report` | Display Claude Code Report in GitHub Step Summary (set to 'false' to disable when using custom formatting) | `true` | \*Either `claude_code_oauth_token` or `anthropic_api_key` is required. @@ -161,7 +162,7 @@ Variables substituted via `envsubst` at runtime: | `execution_file` | Path to Claude Code execution output | | `branch_name` | The branch created by Claude Code for this execution | | `github_token` | The GitHub token used by the action (Claude App token if available). **Sensitive** — do not log or upload as an artifact. | -| `structured_output` | JSON output when using `--json-schema` | +| `structured_output` | JSON string containing all structured output fields when `--json-schema` is provided in `claude_args`. Use `fromJSON()` to parse | | `session_id` | Claude Code session ID that can be used with --resume | ## Examples diff --git a/action.yml b/action.yml index 004e77f..361688c 100644 --- a/action.yml +++ b/action.yml @@ -148,6 +148,10 @@ inputs: description: "Show full JSON output from Claude Code. WARNING: This outputs ALL Claude messages including tool execution results which may contain secrets, API keys, or other sensitive information. These logs are publicly visible in GitHub Actions. Only enable for debugging in non-sensitive environments." required: false default: "false" + display_report: + description: "Display Claude Code Report in GitHub Step Summary (set to 'false' to disable when using custom formatting)" + required: false + default: "true" outputs: execution_file: @@ -160,7 +164,7 @@ outputs: description: "The GitHub token used by the action (Claude App token if available)" value: ${{ steps.claude.outputs.github_token }} structured_output: - description: "JSON output when using --json-schema" + description: "JSON string containing all structured output fields when --json-schema is provided in claude_args. Use fromJSON() to parse: fromJSON(steps.id.outputs.structured_output).field_name" value: ${{ steps.claude.outputs.structured_output }} session_id: description: "The Claude Code session ID that can be used with --resume to continue this conversation" @@ -274,3 +278,4 @@ runs: path_to_claude_code_executable: ${{ inputs.path_to_claude_code_executable }} path_to_bun_executable: ${{ inputs.path_to_bun_executable }} show_full_output: ${{ inputs.show_full_output }} + display_report: ${{ inputs.display_report }}