Update the module catalog generator for Modules

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

Author: MariusStorhaug

.github/actions/update-index/src/Helper.psm1

@@ -831,7 +831,7 @@ function Update-ModuleList {
     $moduleRepos = $Repos | Where-Object {
         $_.Type -eq 'Module' -and $_.Owner -eq 'PSModule'
     } | Sort-Object Name
-    $catalogFolderPath = Join-Path 'docs\content\Modules\Catalog' 'Repositories'
+    $catalogFolderPath = Join-Path 'docs\content\Modules' 'Repositories'
     if (-not (Test-Path $catalogFolderPath)) {
         Write-Host "Creating catalog folder [$catalogFolderPath]"
         $null = New-Item -Path $catalogFolderPath -ItemType Directory
@@ -921,7 +921,7 @@ function Update-ModuleList {
 
     LogGroup 'Write module catalog table to docs index' {
         $moduleTable = $moduleCatalogTableTemplate.Replace('{{ ROWS }}', $moduleTableRows.TrimEnd())
-        Update-MDSection -Path '.\docs\content\Modules\Catalog\index.md' -Name 'MODULE_CATALOG' -Content $moduleTable
+        Update-MDSection -Path '.\docs\content\Modules\index.md' -Name 'MODULE_CATALOG' -Content $moduleTable
         Write-Host 'Module catalog table update completed'
     }
 }

.github/actions/update-index/templates/module-catalog/v2-table.html

@@ -3,10 +3,10 @@
 <table>
     <tr>
         <th width="24%">Name</th>
-        <th width="12%"><img src="../../assets/images/module-catalog/githubtags.svg" alt="Version" title="Version" width="16" height="16"></th>
-        <th width="24%"><img src="../../assets/images/module-catalog/package-variant-closed-check.svg" alt="Process version" title="Process version" width="16" height="16"></th>
-        <th width="10%"><img src="../../assets/images/module-catalog/githubissues.svg" alt="Issues" title="Issues" width="16" height="16"></th>
-        <th width="10%"><img src="../../assets/images/module-catalog/githubpullrequests.svg" alt="Pull requests" title="Pull requests" width="16" height="16"></th>
-        <th width="10%"><img src="../../assets/images/module-catalog/githubstars.svg" alt="Stars" title="Stars" width="16" height="16"></th>
+        <th width="12%"><img src="../assets/images/module-catalog/githubtags.svg" alt="Version" title="Version" width="16" height="16"></th>
+        <th width="24%"><img src="../assets/images/module-catalog/package-variant-closed-check.svg" alt="Process version" title="Process version" width="16" height="16"></th>
+        <th width="10%"><img src="../assets/images/module-catalog/githubissues.svg" alt="Issues" title="Issues" width="16" height="16"></th>
+        <th width="10%"><img src="../assets/images/module-catalog/githubpullrequests.svg" alt="Pull requests" title="Pull requests" width="16" height="16"></th>
+        <th width="10%"><img src="../assets/images/module-catalog/githubstars.svg" alt="Stars" title="Stars" width="16" height="16"></th>
     </tr>
 {{ ROWS }}</table>

.github/actions/update-index/tests/Update-Index.Helpers.Tests.ps1

@@ -0,0 +1,59 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSUseDeclaredVarsMoreThanAssignments',
+    '',
+    Justification = 'The temporary path is assigned before assertions and cleanup.'
+)]
+[CmdletBinding()]
+param()
+
+BeforeAll {
+    Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath '../src/Helper.psm1') -Force
+}
+
+Describe 'Update-ModuleList' {
+    Context 'catalog page at the Modules root' {
+        It 'Update-ModuleList - writes the catalog index and repository page to the new Modules paths' {
+            $testRoot = Join-Path ([System.IO.Path]::GetTempPath()) ("update-index-test-$([guid]::NewGuid())")
+            $modulesPath = Join-Path $testRoot 'docs/content/Modules'
+            $catalogIndexPath = Join-Path $modulesPath 'index.md'
+            New-Item -ItemType Directory -Path $modulesPath -Force | Out-Null
+            Set-Content -Path $catalogIndexPath -Value @(
+                '# Modules'
+                ''
+                '<!-- MODULE_CATALOG_START -->'
+                '<!-- MODULE_CATALOG_END -->'
+            )
+
+            try {
+                Push-Location $testRoot
+                InModuleScope Helper {
+                    Mock Get-RepositoryVersion { '1.2.3' }
+                    Mock Get-RepositoryReadmeContent { '# Example`nExample module summary.' }
+                    Mock Get-MarkdownSummary { 'Example module summary.' }
+                    Mock Get-WorkflowReference { 'v1.2.3' }
+                    Mock Get-ProcessReferenceStatus { 'up-to-date' }
+                    Mock Get-OpenItemCount { 0 }
+
+                    Update-ModuleList -Repos @(
+                        [pscustomobject]@{
+                            Type          = 'Module'
+                            Owner         = 'PSModule'
+                            Name          = 'Example'
+                            Description   = 'Example module.'
+                            DefaultBranch = 'main'
+                            Stars         = 1
+                        }
+                    )
+                }
+
+                $catalogContent = Get-Content -Path $catalogIndexPath -Raw
+                Test-Path (Join-Path $modulesPath 'Repositories/Example.md') | Should -BeTrue
+                $catalogContent | Should -Match '\./Repositories/Example\.md'
+                $catalogContent | Should -Match '\.\./assets/images/module-catalog/githubtags\.svg'
+            } finally {
+                Pop-Location
+                Remove-Item -LiteralPath $testRoot -Recurse -Force -ErrorAction SilentlyContinue
+            }
+        }
+    }
+}

.github/workflows/Test-Actions.yml

@@ -36,6 +36,7 @@ jobs:
         run: |
           Install-PSResource -Name Pester -Version '[5.7.1,6.0.0)' -Repository PSGallery -TrustRepository
           Install-PSResource -Name PSSemVer -Repository PSGallery -TrustRepository
+          Install-PSResource -Name GitHub -Version '[0.43.1,0.44.0)' -Repository PSGallery -TrustRepository
 
       - name: Run action unit tests
         shell: pwsh