-
Notifications
You must be signed in to change notification settings - Fork 2
🚀 [Feature]: Add options to use PR title and body as release title and body #79
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.
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
Conversation
…itle as release name
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces two configuration options allowing the pull request title and body to be used as the release name and release notes, respectively. The changes update both the configuration file (action.yml) and its documentation (README.md) to integrate these options.
- Adds new inputs in action.yml with corresponding environment variable mapping.
- Updates README.md to document the new configuration options.
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
File | Description |
---|---|
action.yml | Added new inputs and environment variable mappings for PR title/body options |
README.md | Updated documentation to include the new configuration options |
Files not reviewed (1)
- scripts/main.ps1: Language not supported
… for improved readability
…and notes parameters
…ed process handling
…ray syntax for execution
…duplicate code checks
…itleAsReleaseName to true
…otes inputs in action.yml and README.md for clarity
Description
UsePRBodyAsReleaseNotes
andUsePRTitleAsReleaseName
inputs. This allow you to configure the action to copy the PR body into the release notes and/or use the PR title as the release name.UsePRBodyAsReleaseNotes = true
). The release title remains as before with using the semantic‑version tag. You can opt out of this new functionality by setting the input(s) tofalse
.📋 How to use the new options
⏭️ Migration guide
Current adopters that relied on the previous default (generated changelog as release notes) should explicitly set
UsePRBodyAsReleaseNotes: false
to keep former behavior.