Skip to content

Commit 4b7d949

Browse files
Match Pester report default names
1 parent 4574c66 commit 4b7d949

3 files changed

Lines changed: 14 additions & 6 deletions

File tree

.github/workflows/Action-Test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,8 +178,8 @@ jobs:
178178
run: |
179179
tests/Assert-ReportPaths.ps1 `
180180
-WorkingDirectory tests/srcTestRepo `
181-
-TestResultPath .PSModule/TestResult/Results.xml `
182-
-CodeCoveragePath .PSModule/CodeCoverage/Coverage.xml
181+
-TestResultPath .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml `
182+
-CodeCoveragePath .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
183183
184184
ActionTestOutputs:
185185
name: Action-Test - [outputs]

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ customize rule selection, severity filtering, and custom rule inclusion.
4141
| `Run_SkipRemainingOnFailure` | Skips remaining tests after failure (None/Run/Container/Block). | false | |
4242
| `CodeCoverage_Enabled` | Enable CodeCoverage. | false | |
4343
| `CodeCoverage_OutputFormat` | Format to use for code coverage report (JaCoCo/CoverageGutters/Cobertura). | false | |
44-
| `CodeCoverage_OutputPath` | Path relative to the current directory where code coverage report is saved. | false | `.PSModule/CodeCoverage/Coverage.xml` |
44+
| `CodeCoverage_OutputPath` | Path relative to the current directory where code coverage report is saved. | false | See below |
4545
| `CodeCoverage_OutputEncoding` | Encoding of the output file. | false | |
4646
| `CodeCoverage_Path` | Directories or files to be used for code coverage. | false | |
4747
| `CodeCoverage_ExcludeTests` | Exclude tests from code coverage. | false | |
@@ -51,7 +51,7 @@ customize rule selection, severity filtering, and custom rule inclusion.
5151
| `CodeCoverage_SingleHitBreakpoints` | Remove breakpoint when it is hit. | false | |
5252
| `TestResult_Enabled` | Enable TestResult. | false | |
5353
| `TestResult_OutputFormat` | Format to use for test result report (NUnitXml/NUnit2.5/NUnit3/JUnitXml). | false | |
54-
| `TestResult_OutputPath` | Path relative to the current directory where test result report is saved. | false | `.PSModule/TestResult/Results.xml` |
54+
| `TestResult_OutputPath` | Path relative to the current directory where test result report is saved. | false | See below |
5555
| `TestResult_OutputEncoding` | Encoding of the output file. | false | |
5656
| `TestResult_TestSuiteName` | Set the name assigned to the root 'test-suite' element. | false | `PSScriptAnalyzer` |
5757
| `Should_ErrorAction` | Controls if Should throws on error. Use 'Stop' or 'Continue'. | false | |
@@ -68,6 +68,14 @@ customize rule selection, severity filtering, and custom rule inclusion.
6868
| `TestDrive_Enabled` | Enable TestDrive. | false | |
6969
| `TestRegistry_Enabled` | Enable TestRegistry. | false | |
7070

71+
The default report paths match the `Invoke-Pester` filename convention while
72+
using `.PSModule` to keep generated files out of the repository root:
73+
74+
```text
75+
TestResult_OutputPath: .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml
76+
CodeCoverage_OutputPath: .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
77+
```
78+
7179
## Outputs
7280

7381
The action provides the following outputs:

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ inputs:
110110
description: |
111111
Path relative to the current directory where code coverage report is saved.
112112
required: false
113-
default: .PSModule/CodeCoverage/Coverage.xml
113+
default: .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
114114
CodeCoverage_OutputEncoding:
115115
description: |
116116
Encoding of the output file.
@@ -151,7 +151,7 @@ inputs:
151151
description: |
152152
Path relative to the current directory where test result report is saved.
153153
required: false
154-
default: .PSModule/TestResult/Results.xml
154+
default: .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml
155155
TestResult_OutputEncoding:
156156
description: |
157157
Encoding of the output file.

0 commit comments

Comments
 (0)