Address Copilot review: validate version format, gate cleanup on stable release, fix archive path and WhatIf, cleanup zip after upload

Author: MariusStorhaug

README.md

@@ -42,7 +42,7 @@ This makes the tested artifact identical to the published artifact (see
 | Name                       | Description                                                                                | Required | Default          |
 | -------------------------- | ------------------------------------------------------------------------------------------ | -------- | ---------------- |
 | `Name`                     | Name of the module. Defaults to the repository name.                                       | No       | Repository name  |
-| `ModulePath`               | Path to the downloaded module folder.                                                      | No       | `outputs/module` |
+| `ModulePath`               | Path to the folder that contains the `<Name>/` module subdirectory (e.g. `outputs/module` must contain `outputs/module/<Name>/`). | No       | `outputs/module` |
 | `APIKey`                   | PowerShell Gallery API key.                                                                | Yes      |                  |
 | `AutoCleanup`              | Delete prerelease tags matching the PR branch after a stable release.                      | No       | `true`           |
 | `WhatIf`                   | Log the changes that would be made without publishing, creating, or deleting anything.    | No       | `false`          |

action.yml

@@ -76,9 +76,10 @@ runs:
       run: ${{ github.action_path }}/src/publish.ps1
 
     - name: Cleanup Prereleases
-      if: inputs.AutoCleanup == 'true' || inputs.WhatIf == 'true'
+      if: env.PSMODULE_PUBLISH_PSMODULE_CONTEXT_IsPrerelease != 'true' && (inputs.AutoCleanup == 'true' || inputs.WhatIf == 'true')
       shell: pwsh
       working-directory: ${{ inputs.WorkingDirectory }}
       env:
         PSMODULE_PUBLISH_PSMODULE_INPUT_WhatIf: ${{ inputs.WhatIf }}
+        PSMODULE_PUBLISH_PSMODULE_CONTEXT_ReleaseTag: ${{ env.PSMODULE_PUBLISH_PSMODULE_CONTEXT_ReleaseTag }}
       run: ${{ github.action_path }}/src/cleanup.ps1

src/cleanup.ps1

@@ -26,6 +26,11 @@ LogGroup 'Load inputs' {
     Write-Host "PR head ref:      [$prHeadRef]"
     Write-Host "Prerelease name:  [$prereleaseName]"
     Write-Host "WhatIf:           [$whatIf]"
+
+    $publishedReleaseTag = $env:PSMODULE_PUBLISH_PSMODULE_CONTEXT_ReleaseTag
+    if (-not [string]::IsNullOrWhiteSpace($publishedReleaseTag)) {
+        Write-Host "Published tag:    [$publishedReleaseTag] (excluded from cleanup)"
+    }
 }
 #endregion Load inputs
 
@@ -37,7 +42,7 @@ LogGroup "Find prereleases to cleanup for [$prereleaseName]" {
         exit $LASTEXITCODE
     }
 
-    $prereleasesToCleanup = $releases | Where-Object { $_.tagName -like "*$prereleaseName*" }
+    $prereleasesToCleanup = $releases | Where-Object { $_.tagName -like "*$prereleaseName*" -and $_.tagName -ne $publishedReleaseTag }
     $tagsToDelete = @($prereleasesToCleanup | ForEach-Object { $_.tagName } | Where-Object { -not [string]::IsNullOrWhiteSpace($_) })
 
     if ($tagsToDelete.Count -eq 0) {

src/publish.ps1

@@ -71,8 +71,12 @@ LogGroup 'Resolve version from manifest' {
     Show-FileContent -Path $manifestFilePath
 
     $manifest = Test-ModuleManifest -Path $manifestFilePath -ErrorAction Stop
-    $moduleVersion = "$($manifest.Version.Major).$($manifest.Version.Minor).$($manifest.Version.Build)"
     $manifestData = Import-PowerShellDataFile -Path $manifestFilePath
+    $moduleVersion = $manifestData.ModuleVersion
+    if (-not ($moduleVersion -match '^\d+\.\d+\.\d+$')) {
+        Write-Error "ModuleVersion [$moduleVersion] must be in Major.Minor.Patch format. Ensure Build-PSModule has stamped the artifact with a final version."
+        exit 1
+    }
     $prerelease = $manifestData.PrivateData.PSData.Prerelease
     if ([string]::IsNullOrWhiteSpace($prerelease)) {
         $prerelease = ''
@@ -91,6 +95,10 @@ LogGroup 'Resolve version from manifest' {
         PRNumber         = $prNumber
         PRHeadRef        = $prHeadRef
     } | Format-List | Out-String
+
+    # Expose publish context to subsequent steps so the cleanup step can gate on release type.
+    "PSMODULE_PUBLISH_PSMODULE_CONTEXT_IsPrerelease=$($createPrerelease.ToString().ToLower())" | Out-File -Path $env:GITHUB_ENV -Append -Encoding utf8
+    "PSMODULE_PUBLISH_PSMODULE_CONTEXT_ReleaseTag=$releaseTag" | Out-File -Path $env:GITHUB_ENV -Append -Encoding utf8
 }
 #endregion Resolve version from manifest
 
@@ -194,17 +202,19 @@ LogGroup 'Create GitHub release' {
     if (Test-Path -Path $zipPath) {
         Remove-Item -Path $zipPath -Force
     }
-    Write-Host "Compressing module to [$zipPath]"
-    Compress-Archive -Path (Join-Path $modulePath '*') -DestinationPath $zipPath -Force
-
     if ($whatIf) {
+        Write-Host "WhatIf: Compress-Archive -Path $modulePath -DestinationPath $zipPath -Force"
         Write-Host "WhatIf: gh release upload $releaseTag $zipPath --clobber"
     } else {
+        Write-Host "Compressing module to [$zipPath]"
+        Compress-Archive -Path $modulePath -DestinationPath $zipPath -Force
+
         gh release upload $releaseTag $zipPath --clobber
         if ($LASTEXITCODE -ne 0) {
             Write-Error "Failed to upload module artifact to release [$releaseTag]."
             exit $LASTEXITCODE
         }
+        Remove-Item -Path $zipPath -Force
         Write-Host "::notice title=📦 Attached module artifact to release::$zipFileName"
     }