Tests PowerShell module repos using PSModule framework rules.

This GitHub Action is a part of the PSModule framework. It is recommended to use the Process-PSModule workflow to automate the whole process of managing the PowerShell module.

Test-PSModule enables:

• Test-Driven Development using Pester via Invoke-Pester.

• The action runs test on the module repository based on Settings:
  • SourceCode - Tests source code style and standards based on PSModule framework rules.
  • Module - Tests the module build module style and standards based on PSModule framework rules.
    • The module is imported in its own context to avoid conflicts with other modules.
• The action returns the test results as action outputs.
• The following reports are calculated and uploaded as artifacts. This is done to support the action being run in matrix jobs.
  • Test suite results. In Process-PSModule this is evaluated in a later job by Get-PesterTestResults
  • Code coverage results. In Process-PSModule this is evaluated in a later job by Get-PesterCodeCoverage

The action fails if any of the tests fail or it fails to run the tests. This is mitigated by the continue-on-error option in the workflow.

It is recommended to use the Process-PSModule workflow to automate the whole process of managing the PowerShell module.

To use the action, create a new file in the .github/workflows directory of the module repository and add the following content.

name: Test-PSModule

on: [push]

jobs:
  Test-PSModule:
    name: Test-PSModule
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repo
        uses: actions/checkout@v4

      - name: Initialize environment
        uses: PSModule/Initialize-PSModule@main

      - name: Test-PSModule
        uses: PSModule/Test-PSModule@main
        with:
          Settings: SourceCode

name: Test-PSModule

on: [push]

jobs:
  Test-PSModule:
    name: Test-PSModule
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repo
        uses: actions/checkout@v4

      - name: Initialize environment
        uses: PSModule/Initialize-PSModule@main

      - name: Test-PSModule
        uses: PSModule/Test-PSModule@main
        with:
          Settings: Module

The PSModule - SourceCode tests verifies the following coding practices that the framework enforces:

The PSModule - Module tests verifies the following coding practices that the framework enforces: