Skip to content

Commit 06798d4

Browse files
Enhance descriptions for StepSummary_Mode in README.md and action.yml for clarity and improved user guidance
1 parent 5097429 commit 06798d4

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This GitHub Action is a part of the [PSModule framework](https://github.com/PSMo
2525
| `Version` | Exact version of GitHub module to install | No | Latest |
2626
| `Prerelease` | Allow prerelease versions | No | `false` |
2727
| `WorkingDirectory` | Working directory for the action | No | `.` |
28-
| `StepSummary_Mode` | Step summary sections to show (`Full`, `None`, or comma-separated list of `Missed,Executed,Files`) | No | `Missed,Files` |
28+
| `StepSummary_Mode` | Controls which sections to show in the GitHub step summary. Use 'Full' for all sections, 'None' to disable, or a comma-separated list of 'Missed, Executed, Files'. | No | `Missed, Files` |
2929
| `CodeCoveragePercentTarget` | Target code coverage percentage | No | Max target from individual reports |
3030

3131
### Example Workflow
@@ -99,7 +99,7 @@ Summary:
9999
StepSummary_Mode: None
100100

101101
# Custom selection
102-
StepSummary_Mode: Missed,Files
102+
StepSummary_Mode: Missed, Files
103103
```
104104
105105
## Troubleshooting

action.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ inputs:
2626
required: false
2727
default: '.'
2828
StepSummary_Mode:
29-
description: Controls which sections to show in the GitHub step summary. Use 'Full' for all sections, 'None' to disable, or a comma-separated list of 'Missed,Executed,Files'.
29+
description: |
30+
Controls which sections to show in the GitHub step summary.
31+
Use 'Full' for all sections, 'None' to disable, or a comma-separated list of 'Missed, Executed, Files'.
3032
required: false
3133
default: Missed, Files
3234
CodeCoveragePercentTarget:

0 commit comments

Comments
 (0)