🚀 [Feature]: Add PR Title and Description as Configurable Release Notes

[MariusStorhaug]

Your pull request title and description are now automatically used as release notes when publishing modules. By default, merging a PR creates a GitHub release with your PR title as a heading and your PR description as the release notes content. Additionally, when a PR is closed without merging, the workflow now automatically cleans up any prerelease versions and tags, preventing orphaned prereleases in the PowerShell Gallery.

• Fixes 🩹 [Patch]: When a PR is closed, but not merged, fast forward to cleanup of prereleases. #73
• Fixes 🚀 [Feature]: Add PR Title and Description as Configurable Release Notes #263
• Fixes [Feature]: Add ReleaseType input to Publish-PSModule for explicit release control #265

PR-based release notes are now the default

Release notes are now automatically generated from your pull request content. When you merge a PR, the workflow creates a GitHub release with:

• Your PR title as an H1 heading with a link to the PR (e.g., # Add retry logic (#123))
• Your PR description as the release notes body

No configuration needed—just write meaningful PR descriptions and they become your release notes.

Customizing release notes behavior

Three settings in PSModule.yml control this behavior:

Setting	Default	Description
Publish.Module.UsePRTitleAsReleaseName	false	Use the PR title as the GitHub release name instead of version string
Publish.Module.UsePRBodyAsReleaseNotes	true	Use the PR description as the release notes content
Publish.Module.UsePRTitleAsNotesHeading	true	Prepend PR title as H1 heading with PR number link in release notes

To disable PR-based release notes and use GitHub's auto-generated notes instead:

Publish:
  Module:
    UsePRBodyAsReleaseNotes: false
    UsePRTitleAsNotesHeading: false

Abandoned PR cleanup

When a PR is closed without merging (abandoned), the workflow now:

1. Skips all test and build jobs entirely
2. Proceeds directly to cleanup
3. Removes any prerelease versions and tags created for that PR

This saves CI resources and ensures abandoned work doesn't leave orphaned prereleases. Controlled by Publish.Module.AutoCleanup (enabled by default).

Action version pinning

All GitHub Actions references now use commit SHAs with version comments for improved security and reproducibility:

• actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
• actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
• PSModule/GitHub-Script@2010983167dc7a41bcd84cb88e698ec18eccb7ca # v1.7.8
• PSModule/Publish-PSModule@e1b338d1266dee28c6d6218756979597c8a77b7a # v2.2.0
• PSModule/Get-PSModuleSettings@28c1805d689dc5bfcfba7489e76c34a6d33d7da8 # v1.4.0

[Copilot]

Pull request overview

This PR adds three new configurable settings for release notes generation based on pull request metadata, aligning with the Auto-Release pattern. The changes enable users to customize whether the PR title is used as the release name, whether the PR body becomes the release notes content, and whether the PR title appears as a heading above the body.

Changes:

• Added three new boolean settings to the Publish.Module configuration section
• Updated the workflow to pass these settings to the Publish-PSModule action
• Documented the new settings in the README configuration table and defaults example

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
README.md	Adds documentation for three new Publish.Module settings (UsePRTitleAsReleaseName, UsePRBodyAsReleaseNotes, UsePRTitleAsNotesHeading) in both the configuration table and defaults YAML example
.github/workflows/Publish-Module.yml	Passes the three new settings from the configuration to the Publish-PSModule action

[Copilot]

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

[Copilot]

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

[Copilot]

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

.github/workflows/Publish-Module.yml:38

• The artifact download and PSResourceGet update steps have been removed, but the workflow still references ModulePath: outputs/module on line 38. Without downloading the module artifact first, the outputs/module directory will not exist, causing the publish step to fail. These removed steps appear necessary for the workflow to function correctly.

      - name: Publish module
        uses: PSModule/Publish-PSModule@feature/releasetype-input
        env:
          GH_TOKEN: ${{ github.token }}
        with:
          Name: ${{ fromJson(inputs.Settings).Name }}
          ModulePath: outputs/module

[Copilot]

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

.github/workflows/Publish-Module.yml:38

• The Publish-Module workflow references 'ModulePath: outputs/module' but no longer downloads the module artifact, and there is no direct dependency on Build-Module in the workflow.yml file. While Build-Module is indirectly a dependency through Build-Site -> Build-Docs -> Build-Module, this creates a fragile dependency chain. If Build-Site or Build-Docs are skipped (which is allowed per the Publish-Module conditions), the module artifact may not exist when this action tries to access it. Consider either: (1) adding Build-Module as an explicit dependency in workflow.yml's Publish-Module job, or (2) documenting that the new [email protected] action handles artifact downloading internally and no longer requires the artifact to be pre-downloaded.

      - name: Publish module
        uses: PSModule/Publish-PSModule@e1b338d1266dee28c6d6218756979597c8a77b7a # v2.2.0
        env:
          GH_TOKEN: ${{ github.token }}
        with:
          Name: ${{ fromJson(inputs.Settings).Name }}
          ModulePath: outputs/module