Skip to content

Commit 7b0d5ff

Browse files
MariusStorhaugMariusStorhaug
committed
Update README.md to include additional configuration options for test execution and reporting
1 parent 305abf7 commit 7b0d5ff

File tree

1 file changed

+43
-43
lines changed

1 file changed

+43
-43
lines changed

‎README.md‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -97,49 +97,49 @@ jobs:
9797
| `Version` | Specifies the version of the GitHub module to be installed. The value must be an exact version. | `false` | |
9898
| `Prerelease` | Allow prerelease versions if available. | `false` | `'false'` |
9999
| `WorkingDirectory` | The working directory to use for the action. This is the root folder where tests and outputs are expected. | `false` | `'.'` |
100-
| `StepSummary_Mode` | Controls which tests to show in the GitHub step summary. Allows "Full" (all tests), "Failed" (only failed tests), or "None" (disable step summary). | `Failed` |
101-
| `StepSummary_ShowTestOverview` | Controls whether to show the test overview table in the GitHub step summary. | `false` |
102-
| `StepSummary_ShowConfiguration` | Controls whether to show the configuration details in the GitHub step summary. | `false` |
103-
| `Run_ExcludePath` | Directories/files to exclude from the run. | |
104-
| `Run_ScriptBlock` | ScriptBlocks containing tests to be executed. | |
105-
| `Run_Container` | ContainerInfo objects containing tests to be executed. | |
106-
| `Run_TestExtension` | Filter used to identify test files (e.g. `.Tests.ps1`). | |
107-
| `Run_Exit` | Whether to exit with a non-zero exit code on failure. | |
108-
| `Run_Throw` | Whether to throw an exception on test failure. | |
109-
| `Run_SkipRun` | Discovery only, skip actual test run. | |
110-
| `Run_SkipRemainingOnFailure` | Skips remaining tests after the first failure. Options: `None`, `Run`, `Container`, `Block`. | |
111-
| `Filter_Tag` | Tags of Describe/Context/It blocks to run. | |
112-
| `Filter_ExcludeTag` | Tags of Describe/Context/It blocks to exclude. | |
113-
| `Filter_Line` | Filter by file + scriptblock start line (e.g. `C:\tests\file1.Tests.ps1:37`). | |
114-
| `Filter_ExcludeLine` | Exclude by file + scriptblock start line. Precedence over `Filter_Line`. | |
115-
| `Filter_FullName` | Full name of a test with wildcards, joined by dot. E.g. `*.describe Get-Item.test1` | |
116-
| `CodeCoverage_Enabled` | Enable code coverage. | |
117-
| `CodeCoverage_OutputFormat` | Format for the coverage report. Possible values: `JaCoCo`, `CoverageGutters`, `Cobertura`. | |
118-
| `CodeCoverage_OutputPath` | Where to save the code coverage report (relative to the current dir). | |
119-
| `CodeCoverage_OutputEncoding` | Encoding of the coverage file. | |
120-
| `CodeCoverage_Path` | Files/directories to measure coverage on (by default, reuses `Path` from the general settings). | |
121-
| `CodeCoverage_ExcludeTests` | Exclude tests themselves from coverage. | |
122-
| `CodeCoverage_RecursePaths` | Recurse through coverage directories. | |
123-
| `CodeCoverage_CoveragePercentTarget` | Desired minimum coverage percentage. | |
124-
| `CodeCoverage_UseBreakpoints` | **Experimental**: When `false`, use a Profiler-based tracer instead of breakpoints. | |
125-
| `CodeCoverage_SingleHitBreakpoints` | Remove breakpoints after first hit. | |
126-
| `TestResult_Enabled` | Enable test-result output (e.g. NUnitXml, JUnitXml). | |
127-
| `TestResult_OutputFormat` | Possible values: `NUnitXml`, `NUnit2.5`, `NUnit3`, `JUnitXml`. | |
128-
| `TestResult_OutputPath` | Where to save the test-result report (relative path). | |
129-
| `TestResult_OutputEncoding` | Encoding of the test-result file. | |
130-
| `Should_ErrorAction` | Controls if `Should` throws on error. Use `Stop` to throw, or `Continue` to fail at the end. | |
131-
| `Debug_ShowFullErrors` | Show Pester internal stack on errors. (Deprecated – overrides `Output.StackTraceVerbosity` to `Full`). | |
132-
| `Debug_WriteDebugMessages` | Write debug messages to screen. | |
133-
| `Debug_WriteDebugMessagesFrom` | Filter debug messages by source. Wildcards allowed. | |
134-
| `Debug_ShowNavigationMarkers` | Write paths after every block/test for easy navigation in Visual Studio Code. | |
135-
| `Debug_ReturnRawResultObject` | Returns an unfiltered result object, for development only. | |
136-
| `Output_Verbosity` | Verbosity: `None`, `Normal`, `Detailed`, `Diagnostic`. | |
137-
| `Output_StackTraceVerbosity` | Stacktrace detail: `None`, `FirstLine`, `Filtered`, `Full`. | |
138-
| `Output_CIFormat` | CI format of error output: `None`, `Auto`, `AzureDevops`, `GithubActions`. | |
139-
| `Output_CILogLevel` | CI log level: `Error` or `Warning`. | |
140-
| `Output_RenderMode` | How to render console output: `Auto`, `Ansi`, `ConsoleColor`, `Plaintext`. | |
141-
| `TestDrive_Enabled` | Enable `TestDrive`. | |
142-
| `TestRegistry_Enabled` | Enable `TestRegistry`. | |
100+
| `StepSummary_Mode` | Controls which tests to show in the GitHub step summary. Allows "Full" (all tests), "Failed" (only failed tests), or "None" (disable step summary). | `false` | `Failed` |
101+
| `StepSummary_ShowTestOverview` | Controls whether to show the test overview table in the GitHub step summary. | `false` | `false` |
102+
| `StepSummary_ShowConfiguration` | Controls whether to show the configuration details in the GitHub step summary. | `false` | `false` |
103+
| `Run_ExcludePath` | Directories/files to exclude from the run. | `false` | |
104+
| `Run_ScriptBlock` | ScriptBlocks containing tests to be executed. | `false` | |
105+
| `Run_Container` | ContainerInfo objects containing tests to be executed. | `false` | |
106+
| `Run_TestExtension` | Filter used to identify test files (e.g. `.Tests.ps1`). | `false` | |
107+
| `Run_Exit` | Whether to exit with a non-zero exit code on failure. | `false` | |
108+
| `Run_Throw` | Whether to throw an exception on test failure. | `false` | |
109+
| `Run_SkipRun` | Discovery only, skip actual test run. | `false` | |
110+
| `Run_SkipRemainingOnFailure` | Skips remaining tests after the first failure. Options: `None`, `Run`, `Container`, `Block`. | `false` | |
111+
| `Filter_Tag` | Tags of Describe/Context/It blocks to run. | `false` | |
112+
| `Filter_ExcludeTag` | Tags of Describe/Context/It blocks to exclude. | `false` | |
113+
| `Filter_Line` | Filter by file + scriptblock start line (e.g. `C:\tests\file1.Tests.ps1:37`). | `false` | |
114+
| `Filter_ExcludeLine` | Exclude by file + scriptblock start line. Precedence over `Filter_Line`. | `false` | |
115+
| `Filter_FullName` | Full name of a test with wildcards, joined by dot. E.g. `*.describe Get-Item.test1` | `false` | |
116+
| `CodeCoverage_Enabled` | Enable code coverage. | `false` | |
117+
| `CodeCoverage_OutputFormat` | Format for the coverage report. Possible values: `JaCoCo`, `CoverageGutters`, `Cobertura`. | `false` | |
118+
| `CodeCoverage_OutputPath` | Where to save the code coverage report (relative to the current dir). | `false` | |
119+
| `CodeCoverage_OutputEncoding` | Encoding of the coverage file. | `false` | |
120+
| `CodeCoverage_Path` | Files/directories to measure coverage on (by default, reuses `Path` from the general settings). | `false` | |
121+
| `CodeCoverage_ExcludeTests` | Exclude tests themselves from coverage. | `false` | |
122+
| `CodeCoverage_RecursePaths` | Recurse through coverage directories. | `false` | |
123+
| `CodeCoverage_CoveragePercentTarget` | Desired minimum coverage percentage. | `false` | |
124+
| `CodeCoverage_UseBreakpoints` | **Experimental**: When `false`, use a Profiler-based tracer instead of breakpoints. | `false` | |
125+
| `CodeCoverage_SingleHitBreakpoints` | Remove breakpoints after first hit. | `false` | |
126+
| `TestResult_Enabled` | Enable test-result output (e.g. NUnitXml, JUnitXml). | `false` | |
127+
| `TestResult_OutputFormat` | Possible values: `NUnitXml`, `NUnit2.5`, `NUnit3`, `JUnitXml`. | `false` | |
128+
| `TestResult_OutputPath` | Where to save the test-result report (relative path). | `false` | |
129+
| `TestResult_OutputEncoding` | Encoding of the test-result file. | `false` | |
130+
| `Should_ErrorAction` | Controls if `Should` throws on error. Use `Stop` to throw, or `Continue` to fail at the end. | `false` | |
131+
| `Debug_ShowFullErrors` | Show Pester internal stack on errors. (Deprecated – overrides `Output.StackTraceVerbosity` to `Full`). | `false` | |
132+
| `Debug_WriteDebugMessages` | Write debug messages to screen. | `false` | |
133+
| `Debug_WriteDebugMessagesFrom` | Filter debug messages by source. Wildcards allowed. | `false` | |
134+
| `Debug_ShowNavigationMarkers` | Write paths after every block/test for easy navigation in Visual Studio Code. | `false` | |
135+
| `Debug_ReturnRawResultObject` | Returns an unfiltered result object, for development only. | `false` | |
136+
| `Output_Verbosity` | Verbosity: `None`, `Normal`, `Detailed`, `Diagnostic`. | `false` | |
137+
| `Output_StackTraceVerbosity` | Stacktrace detail: `None`, `FirstLine`, `Filtered`, `Full`. | `false` | |
138+
| `Output_CIFormat` | CI format of error output: `None`, `Auto`, `AzureDevops`, `GithubActions`. | `false` | |
139+
| `Output_CILogLevel` | CI log level: `Error` or `Warning`. | `false` | |
140+
| `Output_RenderMode` | How to render console output: `Auto`, `Ansi`, `ConsoleColor`, `Plaintext`. | `false` | |
141+
| `TestDrive_Enabled` | Enable `TestDrive`. | `false` | |
142+
| `TestRegistry_Enabled` | Enable `TestRegistry`. | `false` | |
143143

144144
### Outputs
145145

0 commit comments

Comments
 (0)