Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MariusStorhaug wants to merge 18 commits into
base: main
Choose a base branch
from
+133 −61
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
4c3184e
🩹 [Patch]: Add options to use PR title and body for release naming an…
MariusStorhaug Jan 17, 2026
89a62e1
🩹 [Patch]: Update action references in workflows to use the releaseno…
MariusStorhaug Jan 17, 2026
9ca17a5
🩹 [Patch]: Update settings table formatting in README.md for improved…
MariusStorhaug Jan 17, 2026
72f0486
🩹 [Patch]: Add example section for configuring PR-based release notes…
MariusStorhaug Jan 17, 2026
4d5e0b2
🩹 [Patch]: Update action references in workflows to use specific vers…
MariusStorhaug Jan 17, 2026
2231898
Update workflow comments to reflect actual run conditions
MariusStorhaug Jan 18, 2026
0eaec65
🩹 [Patch]: Update Get-PSModuleSettings action reference to version 1.…
MariusStorhaug Jan 18, 2026
06c378a
🩹 [Patch]: Update Publish-Module action reference to use feature/rele…
MariusStorhaug Jan 18, 2026
29d1790
🩹 [Patch]: Remove PrereleaseLabels input from Publish-Module workflow…
MariusStorhaug Jan 18, 2026
269d0cb
Update to use Publish.Module.ReleaseType and Publish.Module.CleanupPr…
MariusStorhaug Jan 18, 2026
bb2831d
🩹 [Patch]: Remove redundant lines in release notes section of README.md
MariusStorhaug Jan 18, 2026
3d50890
🩹 [Patch]: Update Get-PSModuleSettings action reference to use 'clean…
MariusStorhaug Jan 18, 2026
ea29fbd
🩹 [Patch]: Remove redundant steps for downloading module artifact and…
MariusStorhaug Jan 18, 2026
ca019bc
🩹 [Patch]: Replace CleanupPrereleases input with AutoCleanup in Publi…
MariusStorhaug Jan 18, 2026
71887c8
Keep AutoCleanup name instead of renaming to CleanupPrereleases
MariusStorhaug Jan 18, 2026
0ca3b54
docs: Add abandoned PR cleanup documentation
MariusStorhaug Jan 18, 2026
3dc0504
chore: Update Get-PSModuleSettings to v1
MariusStorhaug Jan 18, 2026
2eb2bb9
chore: Pin Get-PSModuleSettings to SHA for v1.4.0
MariusStorhaug Jan 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/Get-Settings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ jobs:
fetch-depth: 0

- name: Get-Settings
uses: PSModule/Get-PSModuleSettings@5be814463ddf37293196c5bd07c861f6fb617a59 # v1.0.3
uses: PSModule/Get-PSModuleSettings@28c1805d689dc5bfcfba7489e76c34a6d33d7da8 # v1.4.0
id: Get-Settings
with:
SettingsPath: ${{ inputs.SettingsPath }}
Expand Down
17 changes: 5 additions & 12 deletions .github/workflows/Publish-Module.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,8 @@ jobs:
persist-credentials: false
fetch-depth: 0

- name: Download module artifact
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
with:
name: module
path: ${{ fromJson(inputs.Settings).WorkingDirectory }}/outputs/module

- name: Update Microsoft.PowerShell.PSResourceGet
shell: pwsh
run: |
Install-PSResource -Name Microsoft.PowerShell.PSResourceGet -Repository PSGallery -TrustRepository

- name: Publish module
uses: PSModule/Publish-PSModule@6c25d139fe51b890f75c057897bd58ac344b192a # v2.0.8
uses: PSModule/Publish-PSModule@feature/releasetype-input
Copy link

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow is referencing a feature branch instead of a stable release tag. Using branch references (like @feature/releasetype-input) in production workflows creates instability as the branch content can change unexpectedly. Consider using a specific commit SHA or version tag once the feature is merged and released.

Suggested change
uses: PSModule/Publish-PSModule@feature/releasetype-input
uses: PSModule/Publish-PSModule@v1

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The removal of the "Download module artifact" and "Update Microsoft.PowerShell.PSResourceGet" steps suggests these are now handled internally by the new action version. However, this creates a dependency on the feature branch implementation. If the action doesn't handle artifact download internally, the publish step will fail. Consider verifying that the referenced action version (feature/releasetype-input) properly handles module artifact retrieval, or document this dependency change in the PR description.

Suggested change
uses: PSModule/Publish-PSModule@feature/releasetype-input
uses: PSModule/Publish-PSModule@v1

Copilot uses AI. Check for mistakes.
env:
GH_TOKEN: ${{ github.token }}
with:
Expand All @@ -53,9 +42,13 @@ jobs:
AutoPatching: ${{ fromJson(inputs.Settings).Publish.Module.AutoPatching }}
DatePrereleaseFormat: ${{ fromJson(inputs.Settings).Publish.Module.DatePrereleaseFormat }}
IgnoreLabels: ${{ fromJson(inputs.Settings).Publish.Module.IgnoreLabels }}
ReleaseType: ${{ fromJson(inputs.Settings).Publish.Module.ReleaseType }}
Copy link

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new Publish.Module.ReleaseType setting is being passed to the Publish-PSModule action but is not documented in the configuration settings table or in the default settings example. According to the PR description, this setting moved from Run.ReleaseType to Publish.Module.ReleaseType, but users need to know what values this setting accepts and what its purpose is.

Copilot uses AI. Check for mistakes.
IncrementalPrerelease: ${{ fromJson(inputs.Settings).Publish.Module.IncrementalPrerelease }}
MajorLabels: ${{ fromJson(inputs.Settings).Publish.Module.MajorLabels }}
MinorLabels: ${{ fromJson(inputs.Settings).Publish.Module.MinorLabels }}
PatchLabels: ${{ fromJson(inputs.Settings).Publish.Module.PatchLabels }}
VersionPrefix: ${{ fromJson(inputs.Settings).Publish.Module.VersionPrefix }}
UsePRTitleAsReleaseName: ${{ fromJson(inputs.Settings).Publish.Module.UsePRTitleAsReleaseName }}
UsePRBodyAsReleaseNotes: ${{ fromJson(inputs.Settings).Publish.Module.UsePRBodyAsReleaseNotes }}
UsePRTitleAsNotesHeading: ${{ fromJson(inputs.Settings).Publish.Module.UsePRTitleAsNotesHeading }}
WorkingDirectory: ${{ fromJson(inputs.Settings).WorkingDirectory }}
10 changes: 5 additions & 5 deletions .github/workflows/workflow.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,10 +248,10 @@ jobs:
Settings: ${{ needs.Get-Settings.outputs.Settings }}

# Runs on:
# - ✅ Open/Updated PR - Publishes prerelease when all tests/coverage/build succeed
# - ✅ Merged PR - Publishes release when all tests/coverage/build succeed
# - ✅ Open/Updated PR - Only with prerelease label: publishes prerelease version
# - ✅ Merged PR - To default branch only: publishes release when all tests/coverage/build succeed
# - ✅ Abandoned PR - Publishes cleanup/retraction version
# - ✅ Manual run - Publishes when all tests/coverage/build succeed
# - ❌ Manual run - Only runs for PR events
Publish-Module:
if: fromJson(needs.Get-Settings.outputs.Settings).Run.PublishModule && needs.Get-Settings.result == 'success' && !cancelled() && (needs.Get-TestResults.result == 'success' || needs.Get-TestResults.result == 'skipped') && (needs.Get-CodeCoverage.result == 'success' || needs.Get-CodeCoverage.result == 'skipped') && (needs.Build-Site.result == 'success' || needs.Build-Site.result == 'skipped')
uses: ./.github/workflows/Publish-Module.yml
Expand Down Expand Up @@ -295,9 +295,9 @@ jobs:

# Runs on:
# - ❌ Open/Updated PR - Site not published for PRs in progress
# - ✅ Merged PR - Deploys site to GitHub Pages after successful merge
# - ✅ Merged PR - To default branch only: deploys site to GitHub Pages
# - ❌ Abandoned PR - Site not published for abandoned changes
# - ❌ Manual run - Only publishes on merged PRs, not manual runs
# - ❌ Manual run - Only publishes on merged PRs to default branch
Publish-Site:
if: fromJson(needs.Get-Settings.outputs.Settings).Run.PublishSite && needs.Get-TestResults.result == 'success' && needs.Get-CodeCoverage.result == 'success' && needs.Build-Site.result == 'success' && !cancelled()
uses: ./.github/workflows/Publish-Site.yml
Expand Down
Loading
Loading