GitHub Action to run Pester tests and generate report attached to Workflow Run

This Action can be used to execute PowerShell Pester tests within a GitHub Workflow, as well as generate a Report from the test results and attach it to the Workflow Run as a Check Run.

Check out the usage below.

Here we see some badges generated along with links to the Gist-based Tests Report as part of a GitHub Workflow associated with this project.

And here are some samples of the actual generated reports:

This Action allows you to specify a combination of filter inputs to resolve tests and invoke Pester on them, and then generate a markdown report from the test results.

Alternatively, if you would like complete control of the testing process, you can just generate your own test results report in the NUnit Test Results 2.5 format and simply have this Action produce the markdown report.

Here's a quick example of how to use this action in your own GitHub Workflows.

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: test module
        id: test_module
        uses: zyborg/pester-tests-report@v1
        with:
          include_paths: tests
          exclude_paths: tests/powershell1,tests/powershell2
          exclude_tags: skip_ci
          report_name: module_tests
          report_title: My Module Tests
          github_token: ${{ secrets.GITHUB_TOKEN }}
    - name: dump test results
      shell: pwsh
      run: |
        Write-Host 'Total Tests Executed...:  ${{ steps.test_module.outputs.total_count }}'
        Write-Host 'Total Tests PASSED.....:  ${{ steps.test_module.outputs.passed_count }}'
        Write-Host 'Total Tests FAILED.....:  ${{ steps.test_module.outputs.failed_count }}'

Additionally (or alternatively) you can generate a Gist-based report, and have it updated with each build. You can also generate a test result badge along with the Gist-based report for reference such as on a README page. Here's an example badge:

This Action defines the following formal inputs.

This Action defines the following formal outputs.

This Action is implemented as a PowerShell GitHub Action.