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

Merged
MariusStorhaug merged 20 commits into from
Jan 20, 2026
Merged

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

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
20 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
67acf00
docs: Clarify abandoned PR behavior in Publish-Module workflow
MariusStorhaug Jan 18, 2026
6832c56
Pin all GitHub Actions to commit SHAs with version comments
MariusStorhaug Jan 20, 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 @@
fetch-depth: 0

- name: Get-Settings
uses: PSModule/Get-PSModuleSettings@5be814463ddf37293196c5bd07c861f6fb617a59 # v1.0.3
uses: PSModule/Get-PSModuleSettings@releasenotes
id: Get-Settings
with:
SettingsPath: ${{ inputs.SettingsPath }}
Expand Down
5 changes: 4 additions & 1 deletion .github/workflows/Publish-Module.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
Install-PSResource -Name Microsoft.PowerShell.PSResourceGet -Repository PSGallery -TrustRepository

- name: Publish module
uses: PSModule/Publish-PSModule@6c25d139fe51b890f75c057897bd58ac344b192a # v2.0.8
uses: PSModule/Publish-PSModule@releasenotes
env:
GH_TOKEN: ${{ github.token }}
with:
Expand All @@ -58,4 +58,7 @@
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 }}
88 changes: 47 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,47 +359,50 @@ The file can be a `JSON`, `YAML`, or `PSD1` file. By default, it will look for `

The following settings are available in the settings file:

| Name | Type | Description | Default |
| -------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------- | ------------------- |
| `Name` | `String` | Name of the module to publish. Defaults to the repository name. | `null` |
| `Test.Skip` | `Boolean` | Skip all tests | `false` |
| `Test.Linux.Skip` | `Boolean` | Skip tests on Linux | `false` |
| `Test.MacOS.Skip` | `Boolean` | Skip tests on macOS | `false` |
| `Test.Windows.Skip` | `Boolean` | Skip tests on Windows | `false` |
| `Test.SourceCode.Skip` | `Boolean` | Skip source code tests | `false` |
| `Test.SourceCode.Linux.Skip` | `Boolean` | Skip source code tests on Linux | `false` |
| `Test.SourceCode.MacOS.Skip` | `Boolean` | Skip source code tests on macOS | `false` |
| `Test.SourceCode.Windows.Skip` | `Boolean` | Skip source code tests on Windows | `false` |
| `Test.PSModule.Skip` | `Boolean` | Skip PSModule framework tests | `false` |
| `Test.PSModule.Linux.Skip` | `Boolean` | Skip PSModule framework tests on Linux | `false` |
| `Test.PSModule.MacOS.Skip` | `Boolean` | Skip PSModule framework tests on macOS | `false` |
| `Test.PSModule.Windows.Skip` | `Boolean` | Skip PSModule framework tests on Windows | `false` |
| `Test.Module.Skip` | `Boolean` | Skip module tests | `false` |
| `Test.Module.Linux.Skip` | `Boolean` | Skip module tests on Linux | `false` |
| `Test.Module.MacOS.Skip` | `Boolean` | Skip module tests on macOS | `false` |
| `Test.Module.Windows.Skip` | `Boolean` | Skip module tests on Windows | `false` |
| `Test.TestResults.Skip` | `Boolean` | Skip test result processing | `false` |
| `Test.CodeCoverage.Skip` | `Boolean` | Skip code coverage tests | `false` |
| `Test.CodeCoverage.PercentTarget` | `Integer` | Target code coverage percentage | `0` |
| `Test.CodeCoverage.StepSummaryMode` | `String` | Step summary mode for code coverage reports | `'Missed, Files'` |
| `Build.Skip` | `Boolean` | Skip all build tasks | `false` |
| `Build.Module.Skip` | `Boolean` | Skip module build | `false` |
| `Build.Docs.Skip` | `Boolean` | Skip documentation build | `false` |
| `Build.Docs.ShowSummaryOnSuccess` | `Boolean` | Show super-linter summary on success for documentation linting | `false` |
| `Build.Site.Skip` | `Boolean` | Skip site build | `false` |
| `Publish.Module.Skip` | `Boolean` | Skip module publishing | `false` |
| `Publish.Module.AutoCleanup` | `Boolean` | Automatically clean up old prerelease module versions | `true` |
| `Publish.Module.AutoPatching` | `Boolean` | Automatically patch module version | `true` |
| `Publish.Module.IncrementalPrerelease` | `Boolean` | Use incremental prerelease versioning | `true` |
| `Publish.Module.DatePrereleaseFormat` | `String` | Format for date-based prerelease (uses [.NET DateTime format strings](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings)) | `''` |
| `Publish.Module.VersionPrefix` | `String` | Prefix for version tags | `'v'` |
| `Publish.Module.MajorLabels` | `String` | Labels indicating a major version bump | `'major, breaking'` |
| `Publish.Module.MinorLabels` | `String` | Labels indicating a minor version bump | `'minor, feature'` |
| `Publish.Module.PatchLabels` | `String` | Labels indicating a patch version bump | `'patch, fix'` |
| `Publish.Module.IgnoreLabels` | `String` | Labels indicating no release | `'NoRelease'` |
| `Linter.Skip` | `Boolean` | Skip repository linting | `false` |
| `Linter.ShowSummaryOnSuccess` | `Boolean` | Show super-linter summary on success for repository linting | `false` |
| `Linter.env` | `Object` | Environment variables for super-linter configuration | `{}` |
| Name | Type | Description | Default |
| ----------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `Name` | `String` | Name of the module to publish. Defaults to the repository name. | `null` |
| `Test.Skip` | `Boolean` | Skip all tests | `false` |
| `Test.Linux.Skip` | `Boolean` | Skip tests on Linux | `false` |
| `Test.MacOS.Skip` | `Boolean` | Skip tests on macOS | `false` |
| `Test.Windows.Skip` | `Boolean` | Skip tests on Windows | `false` |
| `Test.SourceCode.Skip` | `Boolean` | Skip source code tests | `false` |
| `Test.SourceCode.Linux.Skip` | `Boolean` | Skip source code tests on Linux | `false` |
| `Test.SourceCode.MacOS.Skip` | `Boolean` | Skip source code tests on macOS | `false` |
| `Test.SourceCode.Windows.Skip` | `Boolean` | Skip source code tests on Windows | `false` |
| `Test.PSModule.Skip` | `Boolean` | Skip PSModule framework tests | `false` |
| `Test.PSModule.Linux.Skip` | `Boolean` | Skip PSModule framework tests on Linux | `false` |
| `Test.PSModule.MacOS.Skip` | `Boolean` | Skip PSModule framework tests on macOS | `false` |
| `Test.PSModule.Windows.Skip` | `Boolean` | Skip PSModule framework tests on Windows | `false` |
| `Test.Module.Skip` | `Boolean` | Skip module tests | `false` |
| `Test.Module.Linux.Skip` | `Boolean` | Skip module tests on Linux | `false` |
| `Test.Module.MacOS.Skip` | `Boolean` | Skip module tests on macOS | `false` |
| `Test.Module.Windows.Skip` | `Boolean` | Skip module tests on Windows | `false` |
| `Test.TestResults.Skip` | `Boolean` | Skip test result processing | `false` |
| `Test.CodeCoverage.Skip` | `Boolean` | Skip code coverage tests | `false` |
| `Test.CodeCoverage.PercentTarget` | `Integer` | Target code coverage percentage | `0` |
| `Test.CodeCoverage.StepSummaryMode` | `String` | Step summary mode for code coverage reports | `'Missed, Files'` |
| `Build.Skip` | `Boolean` | Skip all build tasks | `false` |
| `Build.Module.Skip` | `Boolean` | Skip module build | `false` |
| `Build.Docs.Skip` | `Boolean` | Skip documentation build | `false` |
| `Build.Docs.ShowSummaryOnSuccess` | `Boolean` | Show super-linter summary on success for documentation linting | `false` |
| `Build.Site.Skip` | `Boolean` | Skip site build | `false` |
| `Publish.Module.Skip` | `Boolean` | Skip module publishing | `false` |
| `Publish.Module.AutoCleanup` | `Boolean` | Automatically clean up old prerelease module versions | `true` |
| `Publish.Module.AutoPatching` | `Boolean` | Automatically patch module version | `true` |
| `Publish.Module.IncrementalPrerelease` | `Boolean` | Use incremental prerelease versioning | `true` |
| `Publish.Module.DatePrereleaseFormat` | `String` | Format for date-based prerelease (uses [.NET DateTime format strings](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings)) | `''` |
| `Publish.Module.VersionPrefix` | `String` | Prefix for version tags | `'v'` |
| `Publish.Module.MajorLabels` | `String` | Labels indicating a major version bump | `'major, breaking'` |
| `Publish.Module.MinorLabels` | `String` | Labels indicating a minor version bump | `'minor, feature'` |
| `Publish.Module.PatchLabels` | `String` | Labels indicating a patch version bump | `'patch, fix'` |
| `Publish.Module.IgnoreLabels` | `String` | Labels indicating no release | `'NoRelease'` |
| `Publish.Module.UsePRTitleAsReleaseName` | `Boolean` | Use the PR title as the GitHub release name instead of version string | `false` |
| `Publish.Module.UsePRBodyAsReleaseNotes` | `Boolean` | Use the PR body as the release notes content | `true` |
| `Publish.Module.UsePRTitleAsNotesHeading` | `Boolean` | Prepend PR title as H1 heading with PR number link before the body | `true` |
| `Linter.Skip` | `Boolean` | Skip repository linting | `false` |
| `Linter.ShowSummaryOnSuccess` | `Boolean` | Show super-linter summary on success for repository linting | `false` |
| `Linter.env` | `Object` | Environment variables for super-linter configuration | `{}` |

<details>
<summary>`PSModule.yml` with all defaults</summary>
Expand Down Expand Up @@ -468,6 +471,9 @@ Publish:
MinorLabels: 'minor, feature'
PatchLabels: 'patch, fix'
IgnoreLabels: 'NoRelease'
UsePRTitleAsReleaseName: false
UsePRBodyAsReleaseNotes: true
UsePRTitleAsNotesHeading: true

Linter:
Skip: false
Expand Down
Loading