Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/Build-Module.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
fetch-depth: 0

- name: Build module
uses: PSModule/Build-PSModule@7a3ae1be38587e8051833d85ffa53c348de3cd0d # v4.0.13
uses: PSModule/Build-PSModule@345728124d201f371a8b0f1aacb98f89000a06dc # v4.0.14
with:
Name: ${{ fromJson(inputs.Settings).Name }}
ArtifactName: ${{ inputs.ArtifactName }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Test-Module.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:
path: ${{ fromJson(inputs.Settings).WorkingDirectory }}/outputs/module

- name: Test-Module
uses: PSModule/Test-PSModule@d4d6d1d2ac1d243ca82c9c199371533e8d2220ef # v3.0.8
uses: PSModule/Test-PSModule@8c3337136dc7cf320da39eeb50e776d04bc9ac73 # v3.0.10
with:
Name: ${{ fromJson(inputs.Settings).Name }}
Debug: ${{ fromJson(inputs.Settings).Debug }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Test-SourceCode.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
fetch-depth: 0

- name: Test-SourceCode
uses: PSModule/Test-PSModule@d4d6d1d2ac1d243ca82c9c199371533e8d2220ef # v3.0.8
uses: PSModule/Test-PSModule@8c3337136dc7cf320da39eeb50e776d04bc9ac73 # v3.0.10
with:
Debug: ${{ fromJson(inputs.Settings).Debug }}
Prerelease: ${{ fromJson(inputs.Settings).Prerelease }}
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,14 @@ The [PSModule - SourceCode tests](./scripts/tests/SourceCode/PSModule/PSModule.T
- [PSModule framework settings for style and standards for modules](https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#module-tests)
- [PSScriptAnalyzer rules](https://github.com/PSModule/Invoke-ScriptAnalyzer)
- This produces a JSON-based report that is used by [Get-PesterTestResults](#get-test-results) evaluate the results of the tests.
- **Code coverage for framework-generated code**: This step collects code coverage for framework-generated
boilerplate. During the [build step](#build-module), [Build-PSModule](https://github.com/PSModule/Build-PSModule)
injects boilerplate code into the compiled `.psm1` file — including type accelerator registration for public classes
and enums, and the `OnRemove` cleanup hook. The framework tests in
[Test-PSModule](https://github.com/PSModule/Test-PSModule) exercise these code paths and produce coverage artifacts
that are aggregated with coverage from [Test-ModuleLocal](#test-module) in the
[Get code coverage](#get-code-coverage) step. This keeps framework-generated lines from counting against the module
author's coverage report.

### Test module

Expand Down Expand Up @@ -299,6 +307,9 @@ The [PSModule - Module tests](./scripts/tests/Module/PSModule/PSModule.Tests.ps1

[workflow](./.github/workflows/Get-CodeCoverage.yml)
- Gathers the code coverage from the previous steps and creates a summary of the results.
- Aggregates coverage from the [Framework test](#framework-test) step (framework-generated boilerplate) and the
[Test module](#test-module) step (module author code). A command executed in either step counts as covered, so
framework-generated lines do not count against the module author's coverage target.
- If the code coverage is below the target, the workflow will fail here.

### Publish module
Expand Down
Loading