Skip to content

Commit 0fec070

Browse files
MariusStorhaugMariusStorhaug
committed
No code changes made; skipping commit.
1 parent 70f75e7 commit 0fec070

File tree

1 file changed

+64
-11
lines changed

1 file changed

+64
-11
lines changed

‎README.md‎

Lines changed: 64 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,73 @@ customize rule selection, severity filtering, and custom rule inclusion.
1515

1616
## Inputs
1717

18-
| Input | Description | Required | Default |
19-
|--------------------|----------------------------------------------------------------|----------|-----------------------------------------------------------------------------|
20-
| `Path` | The path to the code to test. | false | `'.'` |
21-
| `Settings` | The type of tests to run: `Module`, `SourceCode`, or `Custom`. | false | `Custom` |
22-
| `SettingsFilePath` | If `Custom` is selected, the path to the settings file. | false | `${{ github.workspace }}/.github/linters/.powershell-psscriptanalyzer.psd1` |
23-
| `Debug` | Enable debug output. | false | `'false'` |
24-
| `Verbose` | Enable verbose output. | false | `'false'` |
25-
| `Version` | Specifies the exact version of the GitHub module to install. | false | |
26-
| `Prerelease` | Allow prerelease versions if available. | false | `'false'` |
27-
| `WorkingDirectory` | The working directory where the script runs. | false | `${{ github.workspace }}` |
18+
| Input | Description | Required | Default |
19+
|--------------------------------------|--------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------|
20+
| `Path` | The path to the code to test. | false | `'.'` |
21+
| `Settings` | The type of tests to run: `Module`, `SourceCode`, or `Custom`. | false | `Custom` |
22+
| `SettingsFilePath` | If `Custom` is selected, the path to the settings file. | false | `${{ github.workspace }}/.github/linters/.powershell-psscriptanalyzer.psd1` |
23+
| `Debug` | Enable debug output. | false | `'false'` |
24+
| `Verbose` | Enable verbose output. | false | `'false'` |
25+
| `Version` | Specifies the exact version of the GitHub module to install. | false | |
26+
| `Prerelease` | Allow prerelease versions if available. | false | `'false'` |
27+
| `WorkingDirectory` | The working directory where the script runs. | false | `'.'` |
28+
| `ReportAsJson` | Output generated reports in JSON format in addition to the configured format. | false | `'true'` |
29+
| `StepSummary_Enabled` | Controls if a GitHub step summary should be shown. | false | `'false'` |
30+
| `StepSummary_ShowTestOverview` | Controls whether to show the test overview table in the GitHub step summary. | false | `'true'` |
31+
| `StepSummary_ShowTests` | Controls which tests to show in the GitHub step summary (Full/Failed/None). | false | `'Failed'` |
32+
| `StepSummary_ShowConfiguration` | Controls whether to show the configuration details in the GitHub step summary. | false | `'false'` |
33+
| `Run_ExcludePath` | Directories or files to be excluded from the run. | false | |
34+
| `Run_Exit` | Exit with non-zero exit code when the test run fails. | false | |
35+
| `Run_Throw` | Throw an exception when test run fails. | false | |
36+
| `Run_SkipRun` | Runs the discovery phase but skips run. | false | |
37+
| `Run_SkipRemainingOnFailure` | Skips remaining tests after failure (None/Run/Container/Block). | false | |
38+
| `CodeCoverage_Enabled` | Enable CodeCoverage. | false | |
39+
| `CodeCoverage_OutputFormat` | Format to use for code coverage report (JaCoCo/CoverageGutters/Cobertura). | false | |
40+
| `CodeCoverage_OutputPath` | Path relative to the current directory where code coverage report is saved. | false | |
41+
| `CodeCoverage_OutputEncoding` | Encoding of the output file. | false | |
42+
| `CodeCoverage_Path` | Directories or files to be used for code coverage. | false | |
43+
| `CodeCoverage_ExcludeTests` | Exclude tests from code coverage. | false | |
44+
| `CodeCoverage_RecursePaths` | Will recurse through directories in the Path option. | false | |
45+
| `CodeCoverage_CoveragePercentTarget` | Target percent of code coverage that you want to achieve. | false | |
46+
| `CodeCoverage_UseBreakpoints` | EXPERIMENTAL: Use Profiler based tracer instead of breakpoints when false. | false | |
47+
| `CodeCoverage_SingleHitBreakpoints` | Remove breakpoint when it is hit. | false | |
48+
| `TestResult_Enabled` | Enable TestResult. | false | |
49+
| `TestResult_OutputFormat` | Format to use for test result report (NUnitXml/NUnit2.5/NUnit3/JUnitXml). | false | |
50+
| `TestResult_OutputPath` | Path relative to the current directory where test result report is saved. | false | |
51+
| `TestResult_OutputEncoding` | Encoding of the output file. | false | |
52+
| `TestResult_TestSuiteName` | Set the name assigned to the root 'test-suite' element. | false | `PSScriptAnalyzer` |
53+
| `Should_ErrorAction` | Controls if Should throws on error. Use 'Stop' or 'Continue'. | false | |
54+
| `Debug_ShowFullErrors` | Show full errors including Pester internal stack. | false | |
55+
| `Debug_WriteDebugMessages` | Write Debug messages to screen. | false | |
56+
| `Debug_WriteDebugMessagesFrom` | Write Debug messages from a given source. | false | |
57+
| `Debug_ShowNavigationMarkers` | Write paths after every block and test, for easy navigation. | false | |
58+
| `Debug_ReturnRawResultObject` | Returns unfiltered result object, for development only. | false | |
59+
| `Output_Verbosity` | The verbosity of output (None/Normal/Detailed/Diagnostic). | false | |
60+
| `Output_StackTraceVerbosity` | The verbosity of stacktrace output (None/FirstLine/Filtered/Full). | false | |
61+
| `Output_CIFormat` | The CI format of error output (None/Auto/AzureDevops/GithubActions). | false | |
62+
| `Output_CILogLevel` | The CI log level in build logs (Error/Warning). | false | |
63+
| `Output_RenderMode` | The mode used to render console output (Auto/Ansi/ConsoleColor/Plaintext). | false | |
64+
| `TestDrive_Enabled` | Enable TestDrive. | false | |
65+
| `TestRegistry_Enabled` | Enable TestRegistry. | false | |
2866

2967
## Outputs
3068

31-
N/A
69+
The action provides the following outputs:
70+
71+
| Output | Description |
72+
|-------------------------|--------------------------------------------------|
73+
| `Outcome` | The outcome of the test run (success/failure) |
74+
| `Conclusion` | The conclusion of the test run (success/failure) |
75+
| `Executed` | Whether tests were executed (True/False) |
76+
| `Result` | Overall result of the test run (Passed/Failed) |
77+
| `FailedCount` | Number of failed tests |
78+
| `FailedBlocksCount` | Number of failed blocks |
79+
| `FailedContainersCount` | Number of failed containers |
80+
| `PassedCount` | Number of passed tests |
81+
| `SkippedCount` | Number of skipped tests |
82+
| `InconclusiveCount` | Number of inconclusive tests |
83+
| `NotRunCount` | Number of tests not run |
84+
| `TotalCount` | Total count of tests |
3285

3386
## How It Works
3487

0 commit comments

Comments
 (0)