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
16 changes: 4 additions & 12 deletions .github/workflows/generate-pester-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,10 @@ jobs:
- name: Checkout code
uses: actions/checkout@v4

# TEMP workaround for https://github.com/PowerShell/platyPS/issues/663 affection PS 7.4+ used in runner images
- name: Downgrade to PowerShell 7.3
shell: pwsh
run: |
sudo apt-get remove powershell
curl https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb -o packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
sudo apt-get update
sudo apt-get install -y powershell=7.3.11-1.deb
rm packages-microsoft-prod.deb
pwsh --version

# Pester 6 ships a .NET 8 assembly and requires PowerShell 7.4+, so we use the
# runner's default PowerShell. The spurious ProgressAction parameter that PlatyPS
# emits on 7.4+ (https://github.com/PowerShell/platyPS/issues/663) is stripped from
# the generated MDX in generate-command-reference.ps1.
# This step will also install and import modules incl. selected Pester-version
- name: Update Command Reference
id: commands
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/Add-ShouldOperator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/AfterAll.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/AfterEach.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/BeforeAll.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/BeforeDiscovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/BeforeEach.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -200,4 +200,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/ConvertTo-JUnitReport.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/ConvertTo-NUnitReport.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,4 +148,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/ConvertTo-Pester4Result.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Describe.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -210,4 +210,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Export-JUnitReport.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Export-NUnitReport.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Get-ShouldOperator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ standard PowerShell discovery patterns (like `Get-Help Should -Parameter *`).

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
14 changes: 8 additions & 6 deletions docs/commands/InModuleScope.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,13 @@ Export-ModuleMember -Function PublicFunction

# The test script:

Import-Module MyModule
BeforeAll {
Import-Module MyModule
}

InModuleScope MyModule {
Describe 'Testing MyModule' {
It 'Tests the Private function' {
Describe 'Testing MyModule' {
It 'Tests the Private function' {
InModuleScope MyModule {
PrivateFunction | Should -Be $true
}
}
Expand All @@ -69,7 +71,7 @@ InModuleScope MyModule {

Normally you would not be able to access "PrivateFunction" from
the PowerShell session, because the module only exported
"PublicFunction".
"PublicFunction".
Using InModuleScope allowed this call to
"PrivateFunction" to work successfully.

Expand Down Expand Up @@ -204,4 +206,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 6.0.0-alpha5](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 6.0.0-rc2](https://github.com/pester/pester).*
Loading