⚙️ [Maintenance]: Make public help-link validation reusable

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Author: MariusStorhaug

.github/actions/Test-PSModule/src/tests/SourceCode/PSModule/PSModule.Tests.ps1

@@ -59,8 +59,7 @@ BeforeDiscovery {
 
                 @{
                     DocumentationPath = $documentationPath
-                    ExpectedLink      = "https://psmodule.io/$ModuleName/Functions/$documentationPath/"
-                    FilePath          = $_.FullName
+                    FilePath           = $_.FullName
                 }
             }
     } else {
@@ -361,14 +360,24 @@ Describe 'PSModule - SourceCode tests' {
                 }
             }
             It 'Should put the canonical documentation link first for <DocumentationPath> (ID: PublicHelpLink)' -ForEach $publicHelpLinkTestCases {
-                param($DocumentationPath, $ExpectedLink, $FilePath)
+                param($DocumentationPath, $FilePath)
 
                 $content = Get-Content -Path $FilePath -Raw
                 $links = [regex]::Matches($content, '(?ms)^\s*\.LINK\s*\r?\n\s*(?<Uri>\S+)')
 
                 $links.Count | Should -BeGreaterThan 0 -Because "$DocumentationPath should have a documentation link"
-                $links[0].Groups['Uri'].Value |
-                    Should -BeExactly $ExpectedLink -Because "$DocumentationPath should put its canonical documentation link first"
+                $link = $links[0].Groups['Uri'].Value
+                $parsedLink = $null
+                [Uri]::TryCreate($link, [UriKind]::Absolute, [ref]$parsedLink) |
+                    Should -BeTrue -Because "$DocumentationPath should use an absolute documentation link"
+                $parsedLink.Scheme |
+                    Should -BeExactly 'https' -Because "$DocumentationPath should use HTTPS for its documentation link"
+                $parsedLink.Host |
+                    Should -Not -BeNullOrEmpty -Because "$DocumentationPath should specify a documentation host"
+                $parsedLink.AbsolutePath |
+                    Should -BeExactly "/$ModuleName/Functions/$DocumentationPath/" -Because "$DocumentationPath should use the canonical documentation path"
+                $parsedLink.Query | Should -BeNullOrEmpty -Because "$DocumentationPath should not add a query to its documentation link"
+                $parsedLink.Fragment | Should -BeNullOrEmpty -Because "$DocumentationPath should not add a fragment to its documentation link"
             }
             It 'All public functions/filters have tests (ID: FunctionTest)' {
                 $issues = @('')

tests/srcTestRepo/src/functions/public/PSModule/Get-PSModuleTest.ps1

@@ -17,7 +17,7 @@ function Get-PSModuleTest {
         "Hello, World!"
 
         .LINK
-        https://psmodule.io/PSModuleTest2/Functions/PSModule/Get-PSModuleTest/
+        https://docs.example.com/PSModuleTest2/Functions/PSModule/Get-PSModuleTest/
     #>
     [CmdletBinding()]
     param (

tests/srcWithManifestTestRepo/src/functions/public/PSModule/Get-PSModuleTest.ps1

@@ -17,7 +17,7 @@ function Get-PSModuleTest {
         "Hello, World!"
 
         .LINK
-        https://psmodule.io/PSModuleTest/Functions/PSModule/Get-PSModuleTest/
+        https://docs.example.com/PSModuleTest/Functions/PSModule/Get-PSModuleTest/
     #>
     [CmdletBinding()]
     param (