Merge branch 'main' into maintenance/lock-pester-major-6

Author: MariusStorhaug

.github/workflows/Process-PSModule.yml

@@ -27,6 +27,9 @@ permissions:
 
 jobs:
   Process-PSModule:
-    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@60bdf8a5a4c92c53fcf2a8d23f7d5f5c93e6864e # v5.4.3
+    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@d4020f3c9c3621cebae5d8bf4ffaf10f55c1784a # v6.1.2
     secrets:
       APIKEY: ${{ secrets.APIKEY }}
+      TestData: >-
+        { "secrets": { "TEST_SECRET": "${{ secrets.TEST_SECRET }}" },
+        "variables": { "TEST_VARIABLE": ${{ toJSON(vars.TEST_VARIABLE) }} } }

src/functions/public/IndexSection/Get-IndexSectionTest.ps1

@@ -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!"
+}

src/functions/public/IndexSection/index.md

@@ -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.

src/functions/public/NamedSection/Get-NamedSectionTest.ps1

@@ -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!"
+}

src/functions/public/NamedSection/NamedSection.md

@@ -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.

tests/Environment.Tests.ps1

@@ -0,0 +1,29 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSReviewUnusedParameter', '',
+    Justification = 'Required for Pester tests'
+)]
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSUseDeclaredVarsMoreThanAssignments', '',
+    Justification = 'Required for Pester tests'
+)]
+[CmdletBinding()]
+param()
+
+Describe 'TestData is exposed to the module tests' {
+    # Showcase for the Process-PSModule 'TestData' feature. The calling workflow
+    # (.github/workflows/Process-PSModule.yml) passes a repository secret and a repository
+    # variable through a single TestData object, and the framework exposes each of them to
+    # the module tests as an environment variable. To see these run, add a repository secret
+    # named 'TEST_SECRET' and a repository variable named 'TEST_VARIABLE'. When they are not
+    # configured the tests skip, so a fresh repository created from this template stays green.
+
+    It 'Exposes the secret from the "secrets" map as $env:TEST_SECRET' -Skip:([string]::IsNullOrEmpty($env:TEST_SECRET)) {
+        # Values in the "secrets" map are masked in the workflow logs.
+        $env:TEST_SECRET | Should -Not -BeNullOrEmpty
+    }
+
+    It 'Exposes the variable from the "variables" map as $env:TEST_VARIABLE' -Skip:([string]::IsNullOrEmpty($env:TEST_VARIABLE)) {
+        # Values in the "variables" map are not masked.
+        $env:TEST_VARIABLE | Should -Not -BeNullOrEmpty
+    }
+}

tests/PSModuleTest.Tests.ps1

@@ -24,4 +24,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!'
+    }
 }