Skip to content

Conversation

MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Apr 19, 2025

Description

  • Adds UsePRBodyAsReleaseNotes and UsePRTitleAsReleaseName 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.
  • Changes the default behavior of the action from using the built in release note generation using the .github/release.yml instructions to use the PR body for release notes (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) to false.

📋 How to use the new options

steps:
  - uses: PSModule/Auto-Release@vNext
    with:
      UsePRBodyAsReleaseNotes: true   # default is true
      UsePRTitleAsReleaseName: false  # default is false

⏭️ Migration guide

Current adopters that relied on the previous default (generated changelog as release notes) should explicitly set UsePRBodyAsReleaseNotes: false to keep former behavior.

@MariusStorhaug MariusStorhaug self-assigned this Apr 19, 2025
@Copilot Copilot AI review requested due to automatic review settings April 19, 2025 12:18
@MariusStorhaug MariusStorhaug requested a review from a team as a code owner April 19, 2025 12:18
Copy link
Contributor

@Copilot Copilot AI left a 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

@MariusStorhaug MariusStorhaug added Minor and removed Bug labels Apr 19, 2025
@MariusStorhaug MariusStorhaug merged commit 9c8306e into main Apr 19, 2025
13 checks passed
@MariusStorhaug MariusStorhaug deleted the PRDescirptionAsRelease branch April 19, 2025 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🚀[Feature]: Make the release note, the body of the PR.
1 participant