🚀 [Feature]: Add PR-based release name and notes options #58
Conversation
…d notes in GitHub release
…nto releasenotes
There was a problem hiding this comment.
Pull request overview
This PR adds three new configuration options to control how GitHub releases are named and documented when publishing PowerShell modules. The options allow using PR titles and bodies instead of auto-generated content.
Changes:
- Added three new boolean inputs to control release naming and notes formatting
- Implemented logic to conditionally use PR title as release name instead of version string
- Added support for PR body as release notes with optional H1 heading containing PR title and number
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| action.yml | Defines three new inputs (UsePRTitleAsReleaseName, UsePRBodyAsReleaseNotes, UsePRTitleAsNotesHeading) with defaults and environment variable mappings |
| scripts/helpers/Publish-PSModule.ps1 | Parses new configuration options, adds them to configuration output, and implements conditional logic for building GitHub release commands with customizable title and notes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MariusStorhaug
changed the title
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…id escaping issues
…body, using a temp file to avoid escaping issues
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…Module into releasenotes
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The publish action now supports using your pull request title and description to create more meaningful GitHub releases, giving you control over how your module releases appear to users.
New action inputs
Three new inputs are available in the action:
UsePRTitleAsReleaseNamefalseUsePRBodyAsReleaseNotestrueUsePRTitleAsNotesHeadingtrueDefault behavior
With default settings, when a module is published:
v1.2.3)Implementation details
The release creation logic in scripts/helpers/Publish-PSModule.ps1 now dynamically builds the
gh release createcommand based on the configuration:--titlewith PR title whenUsePRTitleAsReleaseNameis enabled--noteswith formatted content when PR body is available--generate-noteswhen no PR content is availableLinting improvements
BIOME_FORMATvalidation via.github/PSModule.ymlpersist-credentials: falseto all checkout stepsgroupsconfiguration to dependabot for cooldown compliancezizmor: ignorecomments for intentional patterns (dangerous-triggers, unpinned external actions)