🚀 [Feature]: Add PR-based release notes settings #5
+25
−10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds three new configuration settings to enable PR-based release notes generation in the PSModule workflow. The settings control whether PR titles and bodies should be used in GitHub releases.
Changes:
- Added three boolean properties to the Publish.Module schema:
UsePRTitleAsReleaseName,UsePRBodyAsReleaseNotes, andUsePRTitleAsNotesHeading - Implemented settings processing in main.ps1 with appropriate default values
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/Settings.schema.json | Added three boolean properties to Publish.Module schema defining PR-based release notes settings |
| scripts/main.ps1 | Added processing for the three new settings with defaults matching Publish-PSModule action |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MariusStorhaug
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The settings action now supports three new configuration options that control how GitHub release notes are generated from pull requests.
New settings schema
The following settings are now available in the
Publish.Modulesection of your.github/PSModule.yml:UsePRTitleAsReleaseNamebooleanfalseUsePRBodyAsReleaseNotesbooleantrueUsePRTitleAsNotesHeadingbooleantrueSchema changes
The JSON schema in scripts/Settings.schema.json has been updated to include the new properties with proper type definitions and descriptions.
Default values
The scripts/main.ps1 file now outputs these settings with sensible defaults:
UsePRTitleAsReleaseName:false(release name uses version tag)UsePRBodyAsReleaseNotes:true(PR body becomes release notes)UsePRTitleAsNotesHeading:true(PR title appears as heading with PR link)