Skip to content

feat: add display_report option to disable step summary #952

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashwin-ant merged 1 commit into from
Feb 15, 2026
+11 −2
Merged

feat: add display_report option to disable step summary #952

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ inputs:
description: "Optional path to a custom Bun executable. If provided, skips automatic Bun installation and uses this executable instead. WARNING: Using an incompatible version may cause problems if the action requires specific Bun features. This input is typically not needed unless you're debugging something specific or have unique needs in your environment."
required: false
default: ""
display_report:
description: "Whether to display the Claude Code Report in GitHub Step Summary. Set to 'false' to disable when using custom formatting solutions."
Copy link
Contributor

@claude claude bot Feb 15, 2026

Choose a reason for hiding this comment

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

Nit: The description says Set to 'false' to disable — since GitHub Actions inputs are always strings, consider mentioning that any value other than "false" (including omitting the input) will keep the report enabled, since the code checks !== "false". This is fine behavior, but users might try display_report: false (boolean YAML) which GitHub Actions coerces to the string "false", so it works — but display_report: no would not disable it, which could be surprising.

A small documentation clarification in the description (e.g., "Set to the string 'false' to disable") or switching the code to check against === "true" (matching the pattern used by use_commit_signing, track_progress, etc.) would make the behavior more predictable. This is low priority since the default is "true" and "false" is the natural input.

required: false
default: "true"
show_full_output:
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
Expand Down Expand Up @@ -218,6 +222,7 @@ runs:
INPUT_PATH_TO_CLAUDE_CODE_EXECUTABLE: ${{ inputs.path_to_claude_code_executable }}
INPUT_PATH_TO_BUN_EXECUTABLE: ${{ inputs.path_to_bun_executable }}
INPUT_SHOW_FULL_OUTPUT: ${{ inputs.show_full_output }}
DISPLAY_REPORT: ${{ inputs.display_report }}
INPUT_PLUGINS: ${{ inputs.plugins }}
INPUT_PLUGIN_MARKETPLACES: ${{ inputs.plugin_marketplaces }}
PATH_TO_CLAUDE_CODE_EXECUTABLE: ${{ inputs.path_to_claude_code_executable }}
Expand Down
8 changes: 6 additions & 2 deletions src/entrypoints/run.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,8 +295,12 @@ async function run() {
}
}

// Write step summary
if (executionFile && existsSync(executionFile)) {
// Write step summary (unless display_report is set to false)
if (
executionFile &&
existsSync(executionFile) &&
process.env.DISPLAY_REPORT !== "false"
) {
await writeStepSummary(executionFile);
}

Expand Down
Loading