You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit cb48ff8
Browse filesBrowse the repository at this point in the historyBrowse files
-Generates a generic missed-path report (Markdown + JSON)
15
-
-Configurable step summary sections
16
-
-Threshold enforcement for minimum code coverage
11
+
-Collects code coverage reports from parallel test runs.
12
+
-Writes Markdown and HTML tables of missed and executed commands.
13
+
-Shows analyzed files and coverage statistics.
14
+
-Writes a missed-path report in Markdown and JSON.
15
+
-Selects step summary sections from the action input.
16
+
-Fails the workflow if coverage is below the target.
17
17
18
18
## Usage
19
19
@@ -26,10 +26,10 @@ This GitHub Action is a part of the [PSModule framework](https://github.com/PSMo
26
26
|`Version`| Version of the GitHub module to install; accepts an exact version or a NuGet version range (for example `[1.2.0, 2.0.0)`) | No | Latest |
27
27
|`Prerelease`| Allow prerelease versions | No |`false`|
28
28
|`WorkingDirectory`| Working directory for the action | No |`.`|
29
-
|`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`|
29
+
|`StepSummary_Mode`|Select the sections 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`|
30
30
|`CodeCoveragePercentTarget`| Target code coverage percentage | No | Max target from individual reports |
31
31
32
-
### Example Workflow
32
+
### Example workflow
33
33
34
34
```yaml
35
35
- name: Process Code Coverage
@@ -43,22 +43,22 @@ This GitHub Action is a part of the [PSModule framework](https://github.com/PSMo
43
43
44
44
| Name | Description |
45
45
| ---- | ----------- |
46
-
| `MissedPathReportPath` | Folder path containing `CodeCoverage-MissedPaths.md` and `CodeCoverage-MissedPaths.json` |
46
+
| `MissedPathReportPath` | Path to the folder with `CodeCoverage-MissedPaths.md` and `CodeCoverage-MissedPaths.json` |
47
47
48
-
### GitHub Step Summary
48
+
### GitHub step summary
49
49
50
-
The action generates a detailed summary visible in the GitHub Actions UI:
50
+
The action writes a detailed summary to the GitHub Actions UI:
51
51
52
-
1. **Coverage Overview Table**
53
-
- Coverage percentage vs target
54
-
- Analyzed/executed/missed command counts
55
-
- Number of files analyzed
52
+
1. **Coverage overview table**
53
+
- Coverage percentage and target
54
+
- Analyzed, executed, and missed command counts
55
+
- Number of analyzed files
56
56
57
-
2. **Expandable Sections**
58
-
- **Missed Commands**: HTML table with code snippets
59
-
- **Executed Commands**: HTML table with code snippets
60
-
- **Analyzed Files**: List of covered files
61
-
- **Missed Paths**: Aggregated missed-command counts grouped by file path
57
+
2. **Expandable sections**
58
+
- **Missed commands**: HTML table with code snippets
59
+
- **Executed commands**: HTML table with code snippets
60
+
- **Analyzed files**: List of covered files
61
+
- **Missed paths**: Missed-command counts for each file path
62
62
63
63
Example summary:
64
64
@@ -77,10 +77,10 @@ Summary:
77
77
78
78
## Requirements
79
79
80
-
1. **Pester 6.1 Code Coverage Reports**
80
+
1. **Pester 6.1 code coverage reports**
81
81
82
-
Preceding steps must generate JSON coverage reports named `*-CodeCoverage*.json`
83
-
from the Pester 6.1 `CodeCoverage` result object. The action consumes
82
+
Earlier steps must create JSON coverage reports named `*-CodeCoverage*.json`
83
+
from the Pester 6.1 `CodeCoverage` result object. The action reads
0 commit comments