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
15 changes: 0 additions & 15 deletions .artifactignore

This file was deleted.

16 changes: 16 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 2
updates:
# Keep the GitHub Actions used by the workflows current — in particular so we
# stay ahead of Node.js runtime deprecations, which land as major bumps.
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
groups:
github-actions:
patterns:
- "*"
update-types:
- major
- minor
- patch
264 changes: 264 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,264 @@
# GitHub Actions CI — the CI for Pester.
#
# This replaces azure-pipelines.yml, which is removed in the same change. Only
# releasing still runs on Azure DevOps (azure-pipelines-publish.yml), because it
# needs the signing service connection and the publishing variable groups.
#
# Shape: build once on Windows, publish the built module as an artifact, then fan
# out the test matrix (all 8 legs run in parallel), then a single "Done" gate.
#
# Coverage: each leg runs `test.ps1 -CC`, producing a JaCoCo coverage.xml. We
# surface it in the run's job summaries (per leg, plus a consolidated table in
# "Done") and keep the raw coverage.xml as an artifact.
#
# Test results are uploaded as artifacts and rendered by test-report.yml, which
# runs after this workflow. That split is what makes the report work for pull
# requests from forks, where this workflow's token cannot create check runs.
#
# Image policy: GA only. We float `*-latest` for the newest GA image and pin the
# one previous GA image ("latest + reasonably recent"). No preview images
# (macos-26, windows-2025-vs2026) are used. Note macos-14 is on the deprecation
# clock (brownouts Oct 2026, removal Nov 2 2026) — swap it out before then.
name: CI

on:
push:
branches: [main, 'rel/*']
paths-ignore:
- '.devcontainer/**'
- '.vscode/**'
- 'docs/**'
- 'images/**'
- '**/*.md'
pull_request:
branches: [main, 'rel/*', 'dev/*']
paths-ignore:
- '.devcontainer/**'
- '.vscode/**'
- 'docs/**'
- 'images/**'
- '**/*.md'
workflow_dispatch:

permissions:
contents: read

env:
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: '1'
DOTNET_CLI_TELEMETRY_OPTOUT: '1'
DOTNET_GENERATE_ASPNET_CERTIFICATE: '0'
DOTNET_NOLOGO: '1'
CI: '1'

# Supersede in-flight runs for the same branch/PR to save minutes.
concurrency:
group: ci-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
name: Build
runs-on: windows-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 1

- name: Setup .NET (global.json)
uses: actions/setup-dotnet@v6
with:
global-json-file: global.json
cache: true
cache-dependency-path: '**/packages.lock.json'

- name: Build module (inline, locked restore)
shell: pwsh
run: |
"Running .NET SDK v$(dotnet --version)"
./build.ps1 -LockedRestore -Clean -Inline

# Publish the built tree so every test leg runs the exact same build.
# Mirrors Azure's `publish: $(Build.SourcesDirectory)` + .artifactignore.
- name: Upload build output
uses: actions/upload-artifact@v7
with:
name: pester-build
retention-days: 1
include-hidden-files: true
path: |
bin/
src/
tst/
build.ps1
test.ps1
global.json
!src/csharp/**/bin/**
!src/csharp/**/obj/**
!src/csharp/.vs/**

test:
name: ${{ matrix.name }}
needs: build
runs-on: ${{ matrix.os }}
timeout-minutes: 20
strategy:
fail-fast: false
matrix:
include:
# PowerShell 7 (psexe: pwsh) — latest + one previous GA per OS.
- { name: 'PS7 - Ubuntu latest', id: ps7-ubuntu-latest, os: ubuntu-latest, psexe: pwsh }
- { name: 'PS7 - Ubuntu 22.04', id: ps7-ubuntu-2204, os: ubuntu-22.04, psexe: pwsh }
- { name: 'PS7 - macOS latest', id: ps7-macos-latest, os: macos-latest, psexe: pwsh }
- { name: 'PS7 - macOS 14', id: ps7-macos-14, os: macos-14, psexe: pwsh }
- { name: 'PS7 - Windows latest', id: ps7-windows-latest, os: windows-latest, psexe: pwsh }
- { name: 'PS7 - Windows 2022', id: ps7-windows-2022, os: windows-2022, psexe: pwsh }
# Windows PowerShell 5.1 (psexe: powershell) — Windows only.
- { name: 'PS5.1 - Windows latest', id: ps51-windows-latest, os: windows-latest, psexe: powershell }
- { name: 'PS5.1 - Windows 2022', id: ps51-windows-2022, os: windows-2022, psexe: powershell }
steps:
# No checkout: the legs run against the artifact from Build, so they test
# the exact same build.
- name: Download build output
uses: actions/download-artifact@v8
with:
name: pester-build
path: .

# `shell:` cannot take a matrix expression, so run from a fixed pwsh (present
# on every runner) and launch the leg's interpreter: pwsh for PS7, powershell
# (Windows PowerShell 5.1) for the 5.1 legs. exit $LASTEXITCODE so a failure
# in the launched process still fails the job.
- name: Test Pester
shell: pwsh
run: |
& ${{ matrix.psexe }} -NoProfile -Command "& ./test.ps1 -CI -CC -PassThru -NoBuild"
exit $LASTEXITCODE

# Render this leg's JaCoCo coverage into the job summary (Azure parity).
- name: Coverage summary
if: always()
shell: pwsh
env:
LEG_NAME: ${{ matrix.name }}
run: |
$ErrorActionPreference = 'Continue'
function Append-Summary([string]$text) {
[System.IO.File]::AppendAllText($env:GITHUB_STEP_SUMMARY, $text, (New-Object System.Text.UTF8Encoding($false)))
}
try {
if (-not (Test-Path 'coverage.xml')) {
Append-Summary "## Coverage - $env:LEG_NAME`n`nNo coverage.xml was produced.`n"
return
}
[xml]$xml = Get-Content -LiteralPath 'coverage.xml'
$counters = @($xml.report.counter) # report-level totals (direct children)
$rows = foreach ($type in 'LINE','INSTRUCTION','METHOD','CLASS') {
$c = $counters | Where-Object { $_.type -eq $type }
if ($c) {
$cov = [int]$c.covered; $mis = [int]$c.missed; $tot = $cov + $mis
$pct = if ($tot) { [math]::Round(100.0 * $cov / $tot, 2) } else { 0 }
$pctStr = ([double]$pct).ToString('0.##', [System.Globalization.CultureInfo]::InvariantCulture)
[pscustomobject]@{ Type = $type; Covered = $cov; Missed = $mis; Total = $tot; PctStr = $pctStr }
}
}
$line = $rows | Where-Object { $_.Type -eq 'LINE' }
$sb = [System.Text.StringBuilder]::new()
[void]$sb.AppendLine("## Coverage - $env:LEG_NAME`n")
if ($line) { [void]$sb.AppendLine("**Line coverage: $($line.PctStr)%** ($($line.Covered)/$($line.Total) lines)`n") }
[void]$sb.AppendLine("| Metric | Covered | Missed | Total | % |")
[void]$sb.AppendLine("|---|--:|--:|--:|--:|")
foreach ($r in $rows) { [void]$sb.AppendLine("| $($r.Type) | $($r.Covered) | $($r.Missed) | $($r.Total) | $($r.PctStr)% |") }
Append-Summary ($sb.ToString() + "`n")
if ($line) { Write-Host "Line coverage ($env:LEG_NAME): $($line.PctStr)%" }
} catch {
Append-Summary "## Coverage - $env:LEG_NAME`n`nCoverage summary failed: $($_.Exception.Message)`n"
}

# Upload this leg's JaCoCo report to Codecov. `flags` keeps a per-leg
# breakdown while Codecov merges all legs into one project report.
# pester/Pester is public, so upload works tokenless (v5 opt-out); a
# CODECOV_TOKEN secret, if set, makes uploads more reliable.
- name: Upload coverage to Codecov
if: always()
uses: codecov/codecov-action@v7
with:
files: ./coverage.xml
disable_search: true
flags: ${{ matrix.id }}
name: ${{ matrix.name }}
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: false

- name: Upload test results
if: always()
uses: actions/upload-artifact@v7
with:
name: results-${{ matrix.id }}
retention-days: 7
if-no-files-found: ignore
path: |
testResults.xml
coverage.xml

# Single gate after the matrix so branch protection and auto-merge only need to
# require "Done" instead of listing all 8 legs. This is the check to require on
# main and on the release branches.
# It also renders a consolidated coverage table (one glance at all legs).
done:
name: Done
needs: test
if: always()
runs-on: ubuntu-latest
steps:
- name: Download coverage reports
if: always()
uses: actions/download-artifact@v8
with:
pattern: results-*
path: coverage-reports

- name: Consolidated coverage
if: always()
shell: pwsh
run: |
$ErrorActionPreference = 'Continue'
function Append-Summary([string]$text) {
[System.IO.File]::AppendAllText($env:GITHUB_STEP_SUMMARY, $text, (New-Object System.Text.UTF8Encoding($false)))
}
function Get-Pct($counters, [string]$type) {
$c = $counters | Where-Object { $_.type -eq $type }
if (-not $c) { return $null }
$cov = [int]$c.covered; $tot = $cov + [int]$c.missed
$pct = if ($tot) { [math]::Round(100.0 * $cov / $tot, 2) } else { 0 }
([double]$pct).ToString('0.##', [System.Globalization.CultureInfo]::InvariantCulture)
}
try {
$files = Get-ChildItem -Path 'coverage-reports' -Recurse -Filter 'coverage.xml' -ErrorAction SilentlyContinue
if (-not $files) { Append-Summary "## Coverage by matrix leg`n`nNo coverage reports found.`n"; return }
$sb = [System.Text.StringBuilder]::new()
[void]$sb.AppendLine("## Coverage by matrix leg`n")
[void]$sb.AppendLine("| Leg | Line % | Instruction % |")
[void]$sb.AppendLine("|---|--:|--:|")
foreach ($f in ($files | Sort-Object FullName)) {
$leg = (Split-Path (Split-Path $f.FullName -Parent) -Leaf) -replace '^results-', ''
try {
[xml]$xml = Get-Content -LiteralPath $f.FullName
$counters = @($xml.report.counter)
$lpct = Get-Pct $counters 'LINE'
$ipct = Get-Pct $counters 'INSTRUCTION'
[void]$sb.AppendLine("| $leg | $(if ($null -ne $lpct) { "$lpct%" } else { 'n/a' }) | $(if ($null -ne $ipct) { "$ipct%" } else { 'n/a' }) |")
} catch {
[void]$sb.AppendLine("| $leg | error | error |")
}
}
Append-Summary ($sb.ToString() + "`n")
} catch {
Append-Summary "## Coverage by matrix leg`n`nConsolidated coverage failed: $($_.Exception.Message)`n"
}

- name: All test legs passed
run: |
echo "Test matrix result: ${{ needs.test.result }}"
[ "${{ needs.test.result }}" = "success" ] || exit 1
echo "done"
44 changes: 44 additions & 0 deletions .github/workflows/test-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Renders the test results produced by ci.yml as check runs on the commit.
#
# This is a separate workflow on purpose. dorny/test-reporter has to create a
# check run, and a workflow triggered by a pull request from a fork gets a
# read-only token that cannot do that. A workflow_run workflow always runs in
# the context of the base repository, with a writable token, so the report shows
# up for fork pull requests too.
# https://github.com/dorny/test-reporter#recommended-setup-for-public-repositories
name: Test report

on:
workflow_run:
workflows: [CI]
types: [completed]

permissions:
contents: read
actions: read # read the artifacts of the run that triggered this one
checks: write # create the check run holding the report

jobs:
report:
name: Test report
runs-on: ubuntu-latest
# Nothing to report when the run never got to the tests.
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event.workflow_run.conclusion == 'failure' }}
steps:
# One artifact per matrix leg (results-ps7-ubuntu-latest, ...), so the
# regex capture becomes the check name: "Tests - ps7-ubuntu-latest".
# Only failed suites and tests are listed; a full pass list is thousands
# of lines and GitHub truncates the report.
- uses: dorny/test-reporter@v3
with:
artifact: /results-(.*)/
name: 'Tests - $1'
path: testResults.xml
reporter: dotnet-nunit
list-suites: failed
list-tests: failed
use-actions-summary: 'false'
# A failed test already fails the CI run, no need to also paint this
# workflow red. fail-on-empty stays on, so a report we cannot find or
# parse is still visible instead of silently doing nothing.
fail-on-error: 'false'
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@ Get-Help ./test.ps1 -Detailed

## Continuous Integration

The Azure Devops Pipeline azure-pipelines.yml file contains the code definition used for builds, unit and integration tests in the CI pipeline.
CI runs on GitHub Actions. `.github/workflows/ci.yml` builds the module once and then runs the test matrix: PS7 and PS5.1, on Windows, Linux (Ubuntu) and MacOS. `.github/workflows/test-report.yml` renders the test results afterwards, so they also show up for pull requests from forks.

Within the pipeline, tests are executed against PS7 and PS5.1, on Windows, Linux (Ubuntu) and MacOS.
Releasing still runs on Azure DevOps (`azure-pipelines-publish.yml`), because it needs the code signing and publishing credentials.

## Documentation

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,9 +173,9 @@ test_script:
See it [in action here!](https://ci.appveyor.com/project/nohwnd/planets)
If you do not need to test your scripts against PowerShell Core, just simply remove the entire line mentioning Ubuntu.

Pester itself is built on AzureDevOps, and distributed mainly via PowerShell gallery.
Pester itself is built on GitHub Actions, and distributed mainly via PowerShell gallery.

[![Build Status](https://nohwnd.visualstudio.com/Pester/_apis/build/status/Pester%20PR?branchName=main)](https://nohwnd.visualstudio.com/Pester/_build/latest?definitionId=6&branchName=main) [![latest version](https://img.shields.io/powershellgallery/v/Pester.svg?label=latest+version)](https://www.powershellgallery.com/packages/Pester) [![downloads](https://img.shields.io/powershellgallery/dt/Pester.svg?label=downloads)](https://www.powershellgallery.com/packages/Pester)
[![Build Status](https://github.com/pester/Pester/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/pester/Pester/actions/workflows/ci.yml?query=branch%3Amain) [![latest version](https://img.shields.io/powershellgallery/v/Pester.svg?label=latest+version)](https://www.powershellgallery.com/packages/Pester) [![downloads](https://img.shields.io/powershellgallery/dt/Pester.svg?label=downloads)](https://www.powershellgallery.com/packages/Pester)

## Further reading

Expand Down
Loading
Loading