Skip to content
Open
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/Process-PSModule.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ permissions:

jobs:
Process-PSModule:
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@ea19a3eb1293246d1b00e4faae1544442c3be0ec # v6.1.1
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@d4020f3c9c3621cebae5d8bf4ffaf10f55c1784a # v6.1.2
secrets:
APIKEY: ${{ secrets.APIKEY }}
# Showcase: send data down to the module tests (see tests/Environment.Tests.ps1).
Expand Down
21 changes: 21 additions & 0 deletions src/functions/public/IndexSection/Get-IndexSectionTest.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
function Get-IndexSectionTest {
<#
.SYNOPSIS
Performs tests on a module.

.DESCRIPTION
Performs tests on a module.

.EXAMPLE
Get-IndexSectionTest -Name 'World'

"Hello, World!"
#>
[CmdletBinding()]
param (
# Name of the person to greet.
[Parameter(Mandatory)]
[string] $Name
)
Write-Output "Hello, $Name!"
}
5 changes: 5 additions & 0 deletions src/functions/public/IndexSection/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Index Section

This section's landing page is provided by an `index.md` file.

When Process-PSModule builds the documentation site, this page becomes the landing page for the **Index Section** group in the navigation on GitHub Pages.
21 changes: 21 additions & 0 deletions src/functions/public/NamedSection/Get-NamedSectionTest.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
function Get-NamedSectionTest {
<#
.SYNOPSIS
Performs tests on a module.

.DESCRIPTION
Performs tests on a module.

.EXAMPLE
Get-NamedSectionTest -Name 'World'

"Hello, World!"
#>
[CmdletBinding()]
param (
# Name of the person to greet.
[Parameter(Mandatory)]
[string] $Name
)
Write-Output "Hello, $Name!"
}
5 changes: 5 additions & 0 deletions src/functions/public/NamedSection/NamedSection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Named Section

This section's landing page is provided by a file named after its folder (`NamedSection.md`).

When Process-PSModule builds the documentation site, this page becomes the landing page for the **Named Section** group in the navigation on GitHub Pages.
6 changes: 6 additions & 0 deletions tests/PSModuleTest.Tests.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,10 @@ Describe 'Module' {
It 'Function: Test-PSModuleTest' {
Test-PSModuleTest -Name 'World' | Should -Be 'Hello, World!'
}
It 'Function: Get-IndexSectionTest' {
Get-IndexSectionTest -Name 'World' | Should -Be 'Hello, World!'
}
It 'Function: Get-NamedSectionTest' {
Get-NamedSectionTest -Name 'World' | Should -Be 'Hello, World!'
}
}
Loading