Skip to content

Tags: PSModule/Get-PesterCodeCoverage

Tags

v1.0.0

Toggle v1.0.0's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🌟 [Major]: Introducing `Get-PesterCodeCoverage` (#1)

## Description

This pull request introduces the `Get-PesterCodeCoverage` GitHub Action
that aggregates Pester code coverage reports and generates a detailed
summary with coverage statistics.

### Core functionality

* `scripts/main.ps1`: Added functionality to aggregate Pester code
coverage reports, normalize file paths, and compute aggregate coverage
statistics. The action now enforces a coverage threshold and generates
detailed GitHub step summaries with expandable sections for missed and
executed commands.

### Tests
* `.github/workflows/Action-Test.yml`: Updated the `Action-Test.yml`
workflow to upload multiple code coverage artifacts for macOS and
Windows environments and added new parameters (`StepSummary_Mode` and
`CodeCoveragePercentTarget`) to control reporting behavior.
* `tests/*`: Added tests reports to use for the Action-Test workflow.

### Documentation
* `README.md`: Updated README to reflect the new functionality,
including detailed usage instructions, input descriptions, and example
workflows. Added a comprehensive explanation of outputs and behavior.

### Action Metadata

* `action.yml`: Updated to align with the new functionality. Added new
inputs (`StepSummary_Mode`, `CodeCoveragePercentTarget`) for
customization.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [x] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v1.0

Toggle v1.0's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🌟 [Major]: Introducing `Get-PesterCodeCoverage` (#1)

## Description

This pull request introduces the `Get-PesterCodeCoverage` GitHub Action
that aggregates Pester code coverage reports and generates a detailed
summary with coverage statistics.

### Core functionality

* `scripts/main.ps1`: Added functionality to aggregate Pester code
coverage reports, normalize file paths, and compute aggregate coverage
statistics. The action now enforces a coverage threshold and generates
detailed GitHub step summaries with expandable sections for missed and
executed commands.

### Tests
* `.github/workflows/Action-Test.yml`: Updated the `Action-Test.yml`
workflow to upload multiple code coverage artifacts for macOS and
Windows environments and added new parameters (`StepSummary_Mode` and
`CodeCoveragePercentTarget`) to control reporting behavior.
* `tests/*`: Added tests reports to use for the Action-Test workflow.

### Documentation
* `README.md`: Updated README to reflect the new functionality,
including detailed usage instructions, input descriptions, and example
workflows. Added a comprehensive explanation of outputs and behavior.

### Action Metadata

* `action.yml`: Updated to align with the new functionality. Added new
inputs (`StepSummary_Mode`, `CodeCoveragePercentTarget`) for
customization.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [x] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v1

Toggle v1's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🌟 [Major]: Introducing `Get-PesterCodeCoverage` (#1)

## Description

This pull request introduces the `Get-PesterCodeCoverage` GitHub Action
that aggregates Pester code coverage reports and generates a detailed
summary with coverage statistics.

### Core functionality

* `scripts/main.ps1`: Added functionality to aggregate Pester code
coverage reports, normalize file paths, and compute aggregate coverage
statistics. The action now enforces a coverage threshold and generates
detailed GitHub step summaries with expandable sections for missed and
executed commands.

### Tests
* `.github/workflows/Action-Test.yml`: Updated the `Action-Test.yml`
workflow to upload multiple code coverage artifacts for macOS and
Windows environments and added new parameters (`StepSummary_Mode` and
`CodeCoveragePercentTarget`) to control reporting behavior.
* `tests/*`: Added tests reports to use for the Action-Test workflow.

### Documentation
* `README.md`: Updated README to reflect the new functionality,
including detailed usage instructions, input descriptions, and example
workflows. Added a comprehensive explanation of outputs and behavior.

### Action Metadata

* `action.yml`: Updated to align with the new functionality. Added new
inputs (`StepSummary_Mode`, `CodeCoveragePercentTarget`) for
customization.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [x] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas