Apply the configured version prefix to the created release tag

The Plan job resolves Publish.Module.VersionPrefix, but the publish action never received it, so the tag was built from the manifest's Major.Minor.Patch alone and repositories on the default 'v' prefix lost it. The prefix now flows from Settings through the action input into the tag.

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

Author: MariusStorhaug

.github/actions/Publish-PSModule/action.yml

@@ -37,6 +37,13 @@ inputs:
     description: Name of the uploaded artifact to download. Must match the name used in the upstream upload-artifact step.
     required: false
     default: module
+  VersionPrefix:
+    description: |
+      Prefix put in front of the version in the git tag of the GitHub release, for example 'v'.
+      Comes from Settings.Publish.Module.VersionPrefix, which the Plan job resolves. The compiled manifest carries the module version as
+      Major.Minor.Patch and cannot carry the prefix, so it is supplied here. An empty value tags the release without a prefix.
+    required: false
+    default: ''
 
 runs:
   using: composite
@@ -65,4 +72,5 @@ runs:
         PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRBodyAsReleaseNotes: ${{ inputs.UsePRBodyAsReleaseNotes }}
         PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRTitleAsReleaseName: ${{ inputs.UsePRTitleAsReleaseName }}
         PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRTitleAsNotesHeading: ${{ inputs.UsePRTitleAsNotesHeading }}
+        PSMODULE_PUBLISH_PSMODULE_INPUT_VersionPrefix: ${{ inputs.VersionPrefix }}
       run: ${{ github.action_path }}/src/publish.ps1

.github/actions/Publish-PSModule/src/Publish-PSModule.Helpers.psm1

@@ -4,22 +4,30 @@
         Builds the git tag used for the GitHub release.
 
         .DESCRIPTION
-        Composes the release tag from the module version and, when present, the prerelease label.
-        The version comes from the compiled manifest, which is the artifact that is published, so the
-        tag always names the exact bytes that were tested and pushed to the PowerShell Gallery.
+        Composes the release tag from the configured version prefix, the module version, and the
+        prerelease label when there is one. The version comes from the compiled manifest, which is the
+        artifact that is published, so the tag always names the exact bytes that were tested and pushed
+        to the PowerShell Gallery. The manifest's ModuleVersion is Major.Minor.Patch by definition and
+        cannot carry the prefix, so the prefix is supplied from the resolved settings
+        (Publish.Module.VersionPrefix) instead. An empty prefix produces an unprefixed tag.
 
         .OUTPUTS
         String with the release tag.
 
         .EXAMPLE
-        Get-ReleaseTag -ModuleVersion '1.1.10'
+        Get-ReleaseTag -VersionPrefix 'v' -ModuleVersion '1.1.10'
 
-        Returns '1.1.10'.
+        Returns 'v1.1.10'.
 
         .EXAMPLE
-        Get-ReleaseTag -ModuleVersion '1.1.10' -Prerelease 'mybranch001'
+        Get-ReleaseTag -VersionPrefix 'v' -ModuleVersion '1.1.10' -Prerelease 'mybranch001'
+
+        Returns 'v1.1.10-mybranch001'.
 
-        Returns '1.1.10-mybranch001'.
+        .EXAMPLE
+        Get-ReleaseTag -VersionPrefix '' -ModuleVersion '1.1.10'
+
+        Returns '1.1.10'.
     #>
     [CmdletBinding()]
     [OutputType([string])]
@@ -29,16 +37,24 @@
         [ValidateNotNullOrEmpty()]
         [string] $ModuleVersion,
 
+        # The prefix put in front of the version, for example 'v'. Empty for an unprefixed repository.
+        [Parameter()]
+        [AllowEmptyString()]
+        [AllowNull()]
+        [string] $VersionPrefix,
+
         # The prerelease label from the compiled manifest. Empty for a stable release.
         [Parameter()]
         [AllowEmptyString()]
         [AllowNull()]
         [string] $Prerelease
     )
 
+    $tag = "$($VersionPrefix.Trim())$ModuleVersion"
+
     if ([string]::IsNullOrWhiteSpace($Prerelease)) {
-        return $ModuleVersion
+        return $tag
     }
 
-    "$ModuleVersion-$($Prerelease.Trim())"
+    "$tag-$($Prerelease.Trim())"
 }

.github/actions/Publish-PSModule/src/publish.ps1

@@ -59,10 +59,14 @@ LogGroup 'Load inputs' {
     $usePRBodyAsReleaseNotes = $env:PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRBodyAsReleaseNotes -eq 'true'
     $usePRTitleAsReleaseName = $env:PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRTitleAsReleaseName -eq 'true'
     $usePRTitleAsNotesHeading = $env:PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRTitleAsNotesHeading -eq 'true'
+    # The prefix the repository tags releases with, resolved by the Plan job from
+    # Settings.Publish.Module.VersionPrefix. Empty means the repository tags without a prefix.
+    $versionPrefix = $env:PSMODULE_PUBLISH_PSMODULE_INPUT_VersionPrefix
 
-    Write-Host "Module name: [$name]"
-    Write-Host "Module path: [$modulePath]"
-    Write-Host "WhatIf:      [$whatIf]"
+    Write-Host "Module name:    [$name]"
+    Write-Host "Module path:    [$modulePath]"
+    Write-Host "Version prefix: [$versionPrefix]"
+    Write-Host "WhatIf:         [$whatIf]"
 }
 #endregion Load inputs
 
@@ -130,10 +134,11 @@ LogGroup 'Resolve version from manifest' {
         $createPrerelease = $true
     }
 
-    $releaseTag = Get-ReleaseTag -ModuleVersion $moduleVersion -Prerelease $prerelease
+    $releaseTag = Get-ReleaseTag -VersionPrefix $versionPrefix -ModuleVersion $moduleVersion -Prerelease $prerelease
 
     [PSCustomObject]@{
         ModuleVersion    = $moduleVersion
+        VersionPrefix    = $versionPrefix
         Prerelease       = $prerelease
         CreatePrerelease = $createPrerelease
         ReleaseTag       = $releaseTag

.github/workflows/Publish-Module.yml

@@ -50,6 +50,7 @@ jobs:
           UsePRTitleAsReleaseName: ${{ fromJson(inputs.Settings).Publish.Module.UsePRTitleAsReleaseName }}
           UsePRBodyAsReleaseNotes: ${{ fromJson(inputs.Settings).Publish.Module.UsePRBodyAsReleaseNotes }}
           UsePRTitleAsNotesHeading: ${{ fromJson(inputs.Settings).Publish.Module.UsePRTitleAsNotesHeading }}
+          VersionPrefix: ${{ fromJson(inputs.Settings).Publish.Module.VersionPrefix }}
           WorkingDirectory: ${{ fromJson(inputs.Settings).WorkingDirectory }}
 
       - name: Cleanup prereleases