Skip to content

Commit 2ac835a

Browse files
MariusStorhaugMariusStorhaug
committed
1 parent 43047b4 commit 2ac835a

1 file changed

Lines changed: 49 additions & 49 deletions

File tree

‎README.md‎

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -152,55 +152,55 @@ jobs:
152152

153153
### Inputs
154154

155-
All are **optional** unless otherwise noted.
156-
157-
| **Input** | **Description** | **Default** |
158-
|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
159-
| `Path` | Path to where tests are located or a configuration file. | `${{ github.workspace }}/tests` |
160-
| `Run_Path` | Directories/files to be searched for tests. | *(none)* |
161-
| `Run_ExcludePath` | Directories/files to exclude from the run. | *(none)* |
162-
| `Run_ScriptBlock` | ScriptBlocks containing tests to be executed. | *(none)* |
163-
| `Run_Container` | ContainerInfo objects containing tests to be executed. See [pester.dev/docs/usage/containers](https://pester.dev/docs/usage/containers). | *(none)* |
164-
| `Run_TestExtension` | Filter used to identify test files (e.g. `.Tests.ps1`). | *(none)* |
165-
| `Run_Exit` | Whether to exit with a non-zero exit code on failure. | *(none)* |
166-
| `Run_Throw` | Whether to throw an exception on test failure. | *(none)* |
167-
| `Run_PassThru` | Return result object to pipeline after finishing the test run. | *(none)* |
168-
| `Run_SkipRun` | Discovery only, skip actual test run. | *(none)* |
169-
| `Run_SkipRemainingOnFailure` | Skips remaining tests after the first failure. Options: `None`, `Run`, `Container`, `Block`. | *(none)* |
170-
| `Filter_Tag` | Tags of Describe/Context/It blocks to run. | *(none)* |
171-
| `Filter_ExcludeTag` | Tags of Describe/Context/It blocks to exclude. | *(none)* |
172-
| `Filter_Line` | Filter by file + scriptblock start line (e.g. `C:\tests\file1.Tests.ps1:37`). | *(none)* |
173-
| `Filter_ExcludeLine` | Exclude by file + scriptblock start line. Precedence over `Filter_Line`. | *(none)* |
174-
| `Filter_FullName` | Full name of a test with wildcards, joined by dot. E.g. `*.describe Get-Item.test1` | *(none)* |
175-
| `CodeCoverage_Enabled` | Enable code coverage. | *(none)* |
176-
| `CodeCoverage_OutputFormat` | Format for the coverage report. Possible values: `JaCoCo`, `CoverageGutters`, `Cobertura`. | *(none)* |
177-
| `CodeCoverage_OutputPath` | Where to save the code coverage report (relative to the current dir). | *(none)* |
178-
| `CodeCoverage_OutputEncoding` | Encoding of the coverage file. | *(none)* |
179-
| `CodeCoverage_Path` | Files/directories to measure coverage on (by default, reuses `Path` from the general settings). | *(none)* |
180-
| `CodeCoverage_ExcludeTests` | Exclude tests themselves from coverage. | *(none)* |
181-
| `CodeCoverage_RecursePaths` | Recurse through coverage directories. | *(none)* |
182-
| `CodeCoverage_CoveragePercentTarget` | Desired minimum coverage percentage. | *(none)* |
183-
| `CodeCoverage_UseBreakpoints` | **Experimental**: When `false`, use a Profiler-based tracer instead of breakpoints. | *(none)* |
184-
| `CodeCoverage_SingleHitBreakpoints` | Remove breakpoints after first hit. | *(none)* |
185-
| `TestResult_Enabled` | Enable test-result output (e.g. NUnitXml, JUnitXml). | *(none)* |
186-
| `TestResult_OutputFormat` | Possible values: `NUnitXml`, `NUnit2.5`, `NUnit3`, `JUnitXml`. | *(none)* |
187-
| `TestResult_OutputPath` | Where to save the test-result report (relative path). | *(none)* |
188-
| `TestResult_OutputEncoding` | Encoding of the test-result file. | *(none)* |
189-
| `TestResult_TestSuiteName` | Name used for the root `test-suite` element in the result file. | *(none)* |
190-
| `Should_ErrorAction` | Controls if `Should` throws on error. Use `Stop` to throw, or `Continue` to fail at the end. | *(none)* |
191-
| `Debug_ShowFullErrors` | Show Pester internal stack on errors. (Deprecated – overrides `Output.StackTraceVerbosity` to `Full`). | *(none)* |
192-
| `Debug_WriteDebugMessages` | Write debug messages to screen. | *(none)* |
193-
| `Debug_WriteDebugMessagesFrom` | Filter debug messages by source. Wildcards allowed. | *(none)* |
194-
| `Debug_ShowNavigationMarkers` | Write paths after every block/test for easy navigation in Visual Studio Code. | *(none)* |
195-
| `Debug_ReturnRawResultObject` | Returns an unfiltered result object, for development only. | *(none)* |
196-
| `Output_Verbosity` | Verbosity: `None`, `Normal`, `Detailed`, `Diagnostic`. | *(none)* |
197-
| `Output_StackTraceVerbosity` | Stacktrace detail: `None`, `FirstLine`, `Filtered`, `Full`. | *(none)* |
198-
| `Output_CIFormat` | CI format of error output: `None`, `Auto`, `AzureDevops`, `GithubActions`. | *(none)* |
199-
| `Output_CILogLevel` | CI log level: `Error` or `Warning`. | *(none)* |
200-
| `Output_RenderMode` | How to render console output: `Auto`, `Ansi`, `ConsoleColor`, `Plaintext`. | *(none)* |
201-
| `TestDrive_Enabled` | Enable `TestDrive`. | *(none)* |
202-
| `TestRegistry_Enabled` | Enable `TestRegistry`. | *(none)* |
203-
| `Debug` | Enable debug mode (`true`/`false`). When `true`, uses `PSModule/Debug@v0`. | `false` |
155+
All are **optional** unless otherwise noted. For more info on the configuration options, see the [Pester documentation](https://pester.dev/docs/usage/configuration).
156+
157+
| **Input** | **Description** | **Default** |
158+
|--------------------------------------|--------------------------------------------------------------------------------------------------------|---------------------------------|
159+
| `Path` | Path to where tests are located or a configuration file. | `${{ github.workspace }}/tests` |
160+
| `Run_Path` | Directories/files to be searched for tests. | *(none)* |
161+
| `Run_ExcludePath` | Directories/files to exclude from the run. | *(none)* |
162+
| `Run_ScriptBlock` | ScriptBlocks containing tests to be executed. | *(none)* |
163+
| `Run_Container` | ContainerInfo objects containing tests to be executed. | *(none)* |
164+
| `Run_TestExtension` | Filter used to identify test files (e.g. `.Tests.ps1`). | *(none)* |
165+
| `Run_Exit` | Whether to exit with a non-zero exit code on failure. | *(none)* |
166+
| `Run_Throw` | Whether to throw an exception on test failure. | *(none)* |
167+
| `Run_PassThru` | Return result object to pipeline after finishing the test run. | *(none)* |
168+
| `Run_SkipRun` | Discovery only, skip actual test run. | *(none)* |
169+
| `Run_SkipRemainingOnFailure` | Skips remaining tests after the first failure. Options: `None`, `Run`, `Container`, `Block`. | *(none)* |
170+
| `Filter_Tag` | Tags of Describe/Context/It blocks to run. | *(none)* |
171+
| `Filter_ExcludeTag` | Tags of Describe/Context/It blocks to exclude. | *(none)* |
172+
| `Filter_Line` | Filter by file + scriptblock start line (e.g. `C:\tests\file1.Tests.ps1:37`). | *(none)* |
173+
| `Filter_ExcludeLine` | Exclude by file + scriptblock start line. Precedence over `Filter_Line`. | *(none)* |
174+
| `Filter_FullName` | Full name of a test with wildcards, joined by dot. E.g. `*.describe Get-Item.test1` | *(none)* |
175+
| `CodeCoverage_Enabled` | Enable code coverage. | *(none)* |
176+
| `CodeCoverage_OutputFormat` | Format for the coverage report. Possible values: `JaCoCo`, `CoverageGutters`, `Cobertura`. | *(none)* |
177+
| `CodeCoverage_OutputPath` | Where to save the code coverage report (relative to the current dir). | *(none)* |
178+
| `CodeCoverage_OutputEncoding` | Encoding of the coverage file. | *(none)* |
179+
| `CodeCoverage_Path` | Files/directories to measure coverage on (by default, reuses `Path` from the general settings). | *(none)* |
180+
| `CodeCoverage_ExcludeTests` | Exclude tests themselves from coverage. | *(none)* |
181+
| `CodeCoverage_RecursePaths` | Recurse through coverage directories. | *(none)* |
182+
| `CodeCoverage_CoveragePercentTarget` | Desired minimum coverage percentage. | *(none)* |
183+
| `CodeCoverage_UseBreakpoints` | **Experimental**: When `false`, use a Profiler-based tracer instead of breakpoints. | *(none)* |
184+
| `CodeCoverage_SingleHitBreakpoints` | Remove breakpoints after first hit. | *(none)* |
185+
| `TestResult_Enabled` | Enable test-result output (e.g. NUnitXml, JUnitXml). | *(none)* |
186+
| `TestResult_OutputFormat` | Possible values: `NUnitXml`, `NUnit2.5`, `NUnit3`, `JUnitXml`. | *(none)* |
187+
| `TestResult_OutputPath` | Where to save the test-result report (relative path). | *(none)* |
188+
| `TestResult_OutputEncoding` | Encoding of the test-result file. | *(none)* |
189+
| `TestResult_TestSuiteName` | Name used for the root `test-suite` element in the result file. | *(none)* |
190+
| `Should_ErrorAction` | Controls if `Should` throws on error. Use `Stop` to throw, or `Continue` to fail at the end. | *(none)* |
191+
| `Debug_ShowFullErrors` | Show Pester internal stack on errors. (Deprecated – overrides `Output.StackTraceVerbosity` to `Full`). | *(none)* |
192+
| `Debug_WriteDebugMessages` | Write debug messages to screen. | *(none)* |
193+
| `Debug_WriteDebugMessagesFrom` | Filter debug messages by source. Wildcards allowed. | *(none)* |
194+
| `Debug_ShowNavigationMarkers` | Write paths after every block/test for easy navigation in Visual Studio Code. | *(none)* |
195+
| `Debug_ReturnRawResultObject` | Returns an unfiltered result object, for development only. | *(none)* |
196+
| `Output_Verbosity` | Verbosity: `None`, `Normal`, `Detailed`, `Diagnostic`. | *(none)* |
197+
| `Output_StackTraceVerbosity` | Stacktrace detail: `None`, `FirstLine`, `Filtered`, `Full`. | *(none)* |
198+
| `Output_CIFormat` | CI format of error output: `None`, `Auto`, `AzureDevops`, `GithubActions`. | *(none)* |
199+
| `Output_CILogLevel` | CI log level: `Error` or `Warning`. | *(none)* |
200+
| `Output_RenderMode` | How to render console output: `Auto`, `Ansi`, `ConsoleColor`, `Plaintext`. | *(none)* |
201+
| `TestDrive_Enabled` | Enable `TestDrive`. | *(none)* |
202+
| `TestRegistry_Enabled` | Enable `TestRegistry`. | *(none)* |
203+
| `Debug` | Enable debug mode (`true`/`false`). When `true`, uses `PSModule/Debug@v0`. | `false` |
204204

205205
No secrets are directly required by this Action.
206206

0 commit comments

Comments
 (0)