🚀 [Feature]: Add PR-based release name and notes options

action.yml

@@ -57,6 +57,18 @@ inputs:
     description: The working directory where the script will run from.
     required: false
     default: '.'
+  UsePRTitleAsReleaseName:
+    description: When enabled, uses the pull request title as the name for the GitHub release. If not set, the version string is used.
+    required: false
+    default: 'false'
+  UsePRBodyAsReleaseNotes:
+    description: When enabled, uses the pull request body as the release notes for the GitHub release. If not set, the release notes are auto-generated.
+    required: false
+    default: 'true'
+  UsePRTitleAsNotesHeading:
+    description: When enabled, the release notes will begin with the pull request title as a H1 heading followed by the pull request body. The title will reference the pull request number.
+    required: false
+    default: 'true'
 
 runs:
   using: composite
@@ -81,4 +93,7 @@ runs:
         PSMODULE_PUBLISH_PSMODULE_INPUT_PatchLabels: ${{ inputs.PatchLabels }}
         PSMODULE_PUBLISH_PSMODULE_INPUT_VersionPrefix: ${{ inputs.VersionPrefix }}
         PSMODULE_PUBLISH_PSMODULE_INPUT_WhatIf: ${{ inputs.WhatIf }}
+        PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRBodyAsReleaseNotes: ${{ inputs.UsePRBodyAsReleaseNotes }}
+        PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRTitleAsReleaseName: ${{ inputs.UsePRTitleAsReleaseName }}
+        PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRTitleAsNotesHeading: ${{ inputs.UsePRTitleAsNotesHeading }}
       run: ${{ github.action_path }}/scripts/main.ps1

scripts/helpers/Publish-PSModule.ps1

@@ -48,18 +48,24 @@
         $majorLabels = $env:PSMODULE_PUBLISH_PSMODULE_INPUT_MajorLabels -split ',' | ForEach-Object { $_.Trim() }
         $minorLabels = $env:PSMODULE_PUBLISH_PSMODULE_INPUT_MinorLabels -split ',' | ForEach-Object { $_.Trim() }
         $patchLabels = $env:PSMODULE_PUBLISH_PSMODULE_INPUT_PatchLabels -split ',' | ForEach-Object { $_.Trim() }
+        $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'
 
         [pscustomobject]@{
-            AutoCleanup           = $autoCleanup
-            AutoPatching          = $autoPatching
-            IncrementalPrerelease = $incrementalPrerelease
-            DatePrereleaseFormat  = $datePrereleaseFormat
-            VersionPrefix         = $versionPrefix
-            WhatIf                = $whatIf
-            IgnoreLabels          = $ignoreLabels
-            MajorLabels           = $majorLabels
-            MinorLabels           = $minorLabels
-            PatchLabels           = $patchLabels
+            AutoCleanup              = $autoCleanup
+            AutoPatching             = $autoPatching
+            IncrementalPrerelease    = $incrementalPrerelease
+            DatePrereleaseFormat     = $datePrereleaseFormat
+            VersionPrefix            = $versionPrefix
+            WhatIf                   = $whatIf
+            IgnoreLabels             = $ignoreLabels
+            MajorLabels              = $majorLabels
+            MinorLabels              = $minorLabels
+            PatchLabels              = $patchLabels
+            UsePRBodyAsReleaseNotes  = $usePRBodyAsReleaseNotes
+            UsePRTitleAsReleaseName  = $usePRTitleAsReleaseName
+            UsePRTitleAsNotesHeading = $usePRTitleAsNotesHeading
         } | Format-List | Out-String
     }
 
@@ -358,25 +364,45 @@
 
         Set-GitHubLogGroup 'New-GitHubRelease' {
             Write-Output 'Create new GitHub release'
+            $releaseCreateCommand = @('release', 'create', $newVersion.ToString())
+
+            # Add title parameter
+            if ($usePRTitleAsReleaseName -and $pull_request.title) {
+                $prTitle = $pull_request.title
+                $releaseCreateCommand += @('--title', $prTitle)
+                Write-Output "Using PR title as release name: [$prTitle]"
+            } else {
+                $releaseCreateCommand += @('--title', $newVersion.ToString())
+            }
+
+            # Add notes parameter
+            if ($usePRTitleAsNotesHeading -and $pull_request.title -and $pull_request.body) {
+                $prTitle = $pull_request.title
+                $prNumber = $pull_request.number
+                $prBody = $pull_request.body
+                $notes = "# $prTitle (#$prNumber)`n`n$prBody"
+                $releaseCreateCommand += @('--notes', $notes)
+                Write-Output 'Using PR title as H1 heading with link and body as release notes'
+            } elseif ($usePRBodyAsReleaseNotes -and $pull_request.body) {
+                $prBody = $pull_request.body
+                $releaseCreateCommand += @('--notes', $prBody)
+                Write-Output 'Using PR body as release notes'
+            } else {
+                $releaseCreateCommand += '--generate-notes'
+            }
+
+            # Add remaining parameters
             if ($createPrerelease) {
-                if ($whatIf) {
-                    Write-Output "WhatIf: gh release create $newVersion --title $newVersion --target $prHeadRef --generate-notes --prerelease"
-                } else {
-                    $releaseURL = gh release create $newVersion --title $newVersion --target $prHeadRef --generate-notes --prerelease
-                    if ($LASTEXITCODE -ne 0) {
-                        Write-Error "Failed to create the release [$newVersion]."
-                        exit $LASTEXITCODE
-                    }
-                }
+                $releaseCreateCommand += @('--target', $prHeadRef, '--prerelease')
+            }
+
+            if ($whatIf) {
+                Write-Output "WhatIf: gh $($releaseCreateCommand -join ' ')"
             } else {
-                if ($whatIf) {
-                    Write-Output "WhatIf: gh release create $newVersion --title $newVersion --generate-notes"
-                } else {
-                    $releaseURL = gh release create $newVersion --title $newVersion --generate-notes
-                    if ($LASTEXITCODE -ne 0) {
-                        Write-Error "Failed to create the release [$newVersion]."
-                        exit $LASTEXITCODE
-                    }
+                $releaseURL = gh @releaseCreateCommand
+                if ($LASTEXITCODE -ne 0) {
+                    Write-Error "Failed to create the release [$newVersion]."
+                    exit $LASTEXITCODE
                 }
             }
             if ($whatIf) {