State Pester test-result behavior with direct actors

Author: MariusStorhaug

.github/actions/Get-PesterTestResults/README.md

@@ -1,40 +1,42 @@
 # Get-PesterTestResults
 
-A GitHub Action that gathers Pester test results for the PSModule process by analyzing test artifacts from the workflow run.
-It validates test execution and results, providing a summary and failing if any tests are unsuccessful.
+This GitHub Action collects Pester test results from workflow artifacts for the PSModule process.
+The action examines test execution and results. It writes a summary and fails if tests do not pass.
 
-This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). It is recommended to use the
-[Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate the whole process of managing the PowerShell module.
+The [PSModule framework](https://github.com/PSModule) includes this action.
+For the recommended setup, use the [Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate PowerShell module management.
 
 ## Usage
 
-This action retrieves test artifacts named `*-TestResults`, processes the contained JSON files, and checks for test failures, unexecuted tests,
-or missing results. It supports three categories of test suites: Source Code, PSModule, and Module tests.
+The action gets artifacts named `*-TestResults` and reads their JSON files.
+It finds test failures, tests that did not run, and missing results.
+The action supports Source Code, PSModule, and Module test suites.
 
 ### Inputs
 
 | Input                   | Description                                                                                                                   | Required | Default   |
 |-------------------------|-------------------------------------------------------------------------------------------------------------------------------|----------|-----------|
-| `SourceCodeTestSuites`  | JSON array specifying OS names for Source Code test suites. Example: `[{"OSName": "Windows"}]`                                | Yes      |           |
-| `PSModuleTestSuites`    | JSON array specifying OS names for PSModule test suites. Example: `[{"OSName": "Linux"}]`                                     | Yes      |           |
-| `ModuleTestSuites`      | JSON array specifying TestName and OSName for Module test suites. Example: `[{"TestName": "Integration", "OSName": "MacOS"}]` | Yes      |           |
+| `SourceCodeTestSuites`  | JSON array that specifies OS names for Source Code test suites. Example: `[{"OSName": "Windows"}]`                                | Yes      |           |
+| `PSModuleTestSuites`    | JSON array that specifies OS names for PSModule test suites. Example: `[{"OSName": "Linux"}]`                                     | Yes      |           |
+| `ModuleTestSuites`      | JSON array that specifies TestName and OSName for Module test suites. Example: `[{"TestName": "Integration", "OSName": "MacOS"}]` | Yes      |           |
 | `BeforeAllModuleLocalResult` | Workflow result for the `BeforeAll-ModuleLocal` job (`success`, `failure`, `skipped`).                                  | No       | `skipped` |
 | `Debug`                 | Enable debug output (`true`/`false`).                                                                                         | No       | `false`   |
 | `Verbose`               | Enable verbose output (`true`/`false`).                                                                                       | No       | `false`   |
-| `Version`               | Exact version of the GitHub module to install (e.g., `1.0.0`).                                                                | No       | Latest    |
-| `Prerelease`            | Allow installing prerelease module versions (`true`/`false`).                                                                 | No       | `false`   |
+| `Version`               | Exact version of the GitHub module to install (for example, `1.0.0`).                                                                | No       | Latest    |
+| `Prerelease`            | Allow prerelease module versions (`true`/`false`).                                                                 | No       | `false`   |
 | `WorkingDirectory`      | Working directory for the script.                                                                                             | No       | `.`       |
 
 ### Secrets
 
-No secrets are required if the action runs in the same repository. The action uses the default `GITHUB_TOKEN` provided by GitHub Actions to access workflow artifacts.
+For runs in the same repository, the action needs no additional secrets.
+The action uses the default `GITHUB_TOKEN` from GitHub Actions to access workflow artifacts.
 
 ### Outputs
 
-This action does not define explicit outputs. Instead:
+The action defines no explicit outputs.
 
-- If any tests fail or errors occur, the action exits with a non-zero code, marking the workflow step as failed.
-- Detailed results are logged in the workflow run's output.
+- If tests fail or errors occur, the action exits with a nonzero code. GitHub Actions marks the workflow step as failed.
+- The action writes detailed results to the workflow run log.
 
 ### Example
 
@@ -48,9 +50,9 @@ This action does not define explicit outputs. Instead:
 ```
 
 ### Notes
-- **Test Suite Inputs**: Must be valid JSON arrays.
+- **Test suite inputs**: The test suite inputs must be valid JSON arrays.
   - `SourceCodeTestSuites` and `PSModuleTestSuites` require `OSName`.
   - `ModuleTestSuites` requires both `TestName` and `OSName`.
-- **BeforeAll module-local failures**: When `BeforeAllModuleLocalResult` is `failure`, the action exits immediately and reports the setup failure as the root cause.
-- **Artifact Names**: The action expects artifacts named `*-TestResults` containing Pester JSON reports.
-- **Failure Conditions**: The action fails if tests are unexecuted, explicitly failed, or if result files are missing.
+- **BeforeAll module-local failures**: If `BeforeAllModuleLocalResult` is `failure`, the action exits immediately and reports the setup failure as the root cause.
+- **Artifact names**: The action expects artifacts named `*-TestResults` with Pester JSON reports.
+- **Failure conditions**: The action fails if tests do not run, tests fail, or result files are missing.