René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"🚀 [Feature]: Add PR Title and Description as Configurable Release Notes","articleBody":"## Describe the change\n\nUpdate the Process-PSModule workflow to use the pull request title and description as release notes, with configurable settings similar to PSModule/Auto-Release.\n\n### Current Behavior\nThe workflow currently uses GitHub's auto-generated release notes when publishing modules. \n\n### Desired Behavior\n- Use the PR title as the release notes header\n- Use the PR description as the content following the header\n- Make this behavior configurable via `.github/PSModule. yml` settings file\n\n### Proposed Configuration Settings\n\nAdd these settings to the `Publish. Module` section in `.github/PSModule.yml`:\n\n```yaml\nPublish:\n  Module: \n    UsePRTitleAsReleaseName: false      # Use PR title as the release name\n    UsePRBodyAsReleaseNotes: true       # Use PR body as release notes content\n    UsePRTitleAsNotesHeading: true      # Add PR title as H1 heading before body\n```\n\n### Reference Implementation (PSModule/Auto-Release)\n\nThe Auto-Release repository already implements this pattern: \n\n**Configuration loading** ([main.ps1#L48-L51](https://github.com/PSModule/Auto-Release/blob/eabd533035e2cb9822160f26f2eda584bd012356/scripts/main.ps1#L48-L51)):\n```powershell\n$usePRBodyAsReleaseNotes = ![string]::IsNullOrEmpty($configuration.UsePRBodyAsReleaseNotes) ?  $configuration.UsePRBodyAsReleaseNotes -eq 'true' : $env: PSMODULE_AUTO_RELEASE_INPUT_UsePRBodyAsReleaseNotes -eq 'true'\n$usePRTitleAsReleaseName = ![string]::IsNullOrEmpty($configuration.UsePRTitleAsReleaseName) ? $configuration.UsePRTitleAsReleaseName -eq 'true' : $env: PSMODULE_AUTO_RELEASE_INPUT_UsePRTitleAsReleaseName -eq 'true'\n$usePRTitleAsNotesHeading = ![string]::IsNullOrEmpty($configuration.UsePRTitleAsNotesHeading) ? $configuration.UsePRTitleAsNotesHeading -eq 'true' : $env:PSMODULE_AUTO_RELEASE_INPUT_UsePRTitleAsNotesHeading -eq 'true'\n```\n\n**Release creation logic** ([main.ps1#L223-L279](https://github.com/PSModule/Auto-Release/blob/eabd533035e2cb9822160f26f2eda584bd012356/scripts/main.ps1#L223-L279)):\n```powershell\nif ($usePRTitleAsReleaseName) {\n    $prTitle = $pull_request.title\n    $releaseCreateCommand += @('--title', \"$prTitle\")\n}\n\n$notes = ''\nif ($usePRTitleAsNotesHeading) {\n    $prTitle = $pull_request.title\n    $prNumber = $pull_request.number\n    $notes += \"# $prTitle (#$prNumber)`n`n\"\n}\nif ($usePRBodyAsReleaseNotes) {\n    $prBody = $pull_request.body\n    $notes += $prBody\n}\nif (-not [string]::IsNullOrWhiteSpace($notes)) {\n    $releaseCreateCommand += @('--notes', $notes)\n} else {\n    $releaseCreateCommand += '--generate-notes'\n}\n```\n\n### Implementation Steps\n\n1. **Check PSModule/Publish-PSModule action**:  Verify if the action at `.github/workflows/Publish-Module.yml` already supports these parameters (it uses `PSModule/Publish-PSModule@6c25d139fe51b890f75c057897bd58ac344b192a`)\n\n2. **Update settings schema**: Add the three new settings to the configuration documentation in README.md under the `Publish. Module` section\n\n3. **Pass settings to action**: Update `.github/workflows/Publish-Module.yml` to pass these settings: \n   ```yaml\n   UsePRTitleAsReleaseName: ${{ fromJson(inputs.Settings).Publish.Module.UsePRTitleAsReleaseName }}\n   UsePRBodyAsReleaseNotes: ${{ fromJson(inputs.Settings).Publish.Module.UsePRBodyAsReleaseNotes }}\n   UsePRTitleAsNotesHeading: ${{ fromJson(inputs. Settings).Publish.Module.UsePRTitleAsNotesHeading }}\n   ```\n\n4. **Set default values**:  Ensure backwards compatibility by setting sensible defaults (following Auto-Release defaults)\n\n5. **Update documentation**: Add examples to README.md showing how to configure these settings\n\n### Benefits\n\n- Consistent release note generation across PSModule repositories\n- More meaningful release notes from PR content\n- Maintains compatibility with Auto-Release configuration patterns\n- Backwards compatible (current behavior unchanged unless configured)","author":{"url":"https://github.com/MariusStorhaug","@type":"Person","name":"MariusStorhaug"},"datePublished":"2026-01-17T19:58:37.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/263/Process-PSModule/issues/263"}