🚀[Feature]: Add option to use PR title heading in release notes #80
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds an option to prefix GitHub release notes with the pull request title as an H2 heading.
- Introduce
UsePRTitleAsNotesHeadinginput inaction.yml - Support the option in
scripts/main.ps1when building release notes - Document the new option and default in
README.md
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| scripts/main.ps1 | Implement handling of UsePRTitleAsNotesHeading flag |
| action.yml | Add new UsePRTitleAsNotesHeading input definition |
| README.md | Document UsePRTitleAsNotesHeading option and default |
Comments suppressed due to low confidence (1)
scripts/main.ps1:50
- New configuration flag introduces behavior that isn’t covered by existing tests; consider adding unit or integration tests to validate this code path.
$usePRTitleAsNotesHeading = ![string]::IsNullOrEmpty($configuration.UsePRTitleAsNotesHeading) ? $configuration.UsePRTitleAsNotesHeading -eq 'true' : $env:PSMODULE_AUTO_RELEASE_INPUT_UsePRTitleAsNotesHeading -eq 'true'
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Summary
This update introduces a new configuration option,
UsePRTitleAsNotesHeading, which uses the pull request (PR) title to be used as a heading in the generated release notes. When enabled, the PR title will appear as a first-level heading (#) in the release notes, enhancing readability and organization.✅ Changes
UsePRTitleAsNotesHeadingconfiguration option to control the inclusion of PR titles as headings in release notes.🛠 Configuration
As this feature is enabled by default, disable it by setting the
UsePRTitleAsNotesHeadingoption tofalseon the action.