Releases: PSModule/Auto-Release
v1.9.2
Bump actions/checkout from 4 to 5 (#82)
Bumps actions/checkout from 4 to 5.
Release notes
Sourced from actions/checkout's releases.
v5.0.0
What's Changed
- Update actions checkout to use node 24 by
@salmanmkc
in actions/checkout#2226- Prepare v5.0.0 release by
@salmanmkc
in actions/checkout#2238
⚠️ Minimum Compatible Runner Versionv2.327.1
Release NotesMake sure your runner is updated to this version or newer to use this release.
Full Changelog: actions/checkout@v4...v5.0.0
v4.3.0
What's Changed
- docs: update README.md by
@motss
in actions/checkout#1971- Add internal repos for checking out multiple repositories by
@mouismail
in actions/checkout#1977- Documentation update - add recommended permissions to Readme by
@benwells
in actions/checkout#2043- Adjust positioning of user email note and permissions heading by
@joshmgross
in actions/checkout#2044- Update README.md by
@nebuk89
in actions/checkout#2194- Update CODEOWNERS for actions by
@TingluoHuang
in actions/checkout#2224- Update package dependencies by
@salmanmkc
in actions/checkout#2236- Prepare release v4.3.0 by
@salmanmkc
in actions/checkout#2237New Contributors
@motss
made their first contribution in actions/checkout#1971@mouismail
made their first contribution in actions/checkout#1977@benwells
made their first contribution in actions/checkout#2043@nebuk89
made their first contribution in actions/checkout#2194@salmanmkc
made their first contribution in actions/checkout#2236Full Changelog: actions/checkout@v4...v4.3.0
v4.2.2
What's Changed
url-helper.ts
now leverages well-known environment variables by@jww3
in actions/checkout#1941- Expand unit test coverage for
isGhes
by@jww3
in actions/checkout#1946Full Changelog: actions/checkout@v4.2.1...v4.2.2
v4.2.1
What's Changed
- Check out other refs/* by commit if provided, fall back to ref by
@orhantoy
in actions/checkout#1924New Contributors
@Jcambass
made their first contribution in actions/checkout#1919Full Changelog: actions/checkout@v4.2.0...v4.2.1
... (truncated)
Changelog
Sourced from actions/checkout's changelog.
Changelog
V5.0.0
- Update actions checkout to use node 24 by
@salmanmkc
in actions/checkout#2226V4.3.0
- docs: update README.md by
@motss
in actions/checkout#1971- Add internal repos for checking out multiple repositories by
@mouismail
in actions/checkout#1977- Documentation update - add recommended permissions to Readme by
@benwells
in actions/checkout#2043- Adjust positioning of user email note and permissions heading by
@joshmgross
in actions/checkout#2044- Update README.md by
@nebuk89
in actions/checkout#2194- Update CODEOWNERS for actions by
@TingluoHuang
in actions/checkout#2224- Update package dependencies by
@salmanmkc
in actions/checkout#2236v4.2.2
url-helper.ts
now leverages well-known environment variables by@jww3
in actions/checkout#1941- Expand unit test coverage for
isGhes
by@jww3
in actions/checkout#1946v4.2.1
- Check out other refs/* by commit if provided, fall back to ref by
@orhantoy
in actions/checkout#1924v4.2.0
- Add Ref and Commit outputs by
@lucacome
in actions/checkout#1180- Dependency updates by
@dependabot
- actions/checkout#1777, actions/checkout#1872v4.1.7
- Bump the minor-npm-dependencies group across 1 directory with 4 updates by
@dependabot
in actions/checkout#1739- Bump actions/checkout from 3 to 4 by
@dependabot
in actions/checkout#1697- Check out other refs/* by commit by
@orhantoy
in actions/checkout#1774- Pin actions/checkout's own workflows to a known, good, stable version. by
@jww3
in actions/checkout#1776v4.1.6
- Check platform to set archive extension appropriately by
@cory-miller
in actions/checkout#1732v4.1.5
- Update NPM dependencie...
v1.9.1
🩹 [Patch]: Refactor release notes handling to improve clarity and structure (#81)
Description
This pull request refactors the logic for constructing release notes in scripts/main.ps1
to improve clarity and maintainability. The changes separate the handling of PR title and body into distinct blocks and ensure that notes are only added when they are non-empty.
Improvements to release notes construction:
- Refactored the logic to initialize
$notes
as an empty string and append the PR title and body conditionally, instead of combining them in a single step. This improves readability and modularity. - Added a check to ensure that
$notes
is non-empty before appending it to the$releaseCreateCommand
, preventing unnecessary arguments when no notes are provided. - Enhanced debugging output by including the constructed
gh
arguments for better traceability during execution.
v1.9.0
🚀[Feature]: Add option to use PR title heading in release notes (#80)
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
- Added
UsePRTitleAsNotesHeading
configuration option to control the inclusion of PR titles as headings in release notes. - Updated the release note generation logic to conditionally include PR titles based on the new configuration setting.
🛠 Configuration
As this feature is enabled by default, disable it by setting the UsePRTitleAsNotesHeading
option to false
on the action.
v1.8.0
Description
- Adds
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.- Fixes #72
- 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) tofalse
.
📋 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.
v1.7.27
What's Changed
Other Changes
- 🩹 [Patch]: Improve module installation logic by @MariusStorhaug in #78
Full Changelog: v1...v1.7.27
v1.7.26
What's Changed
Other Changes
- 🩹 [Patch]: Update README to clarify GITHUB_TOKEN usage by @MariusStorhaug in #77
Full Changelog: v1...v1.7.26
v1.7.25
What's Changed
Other Changes
- 🩹 [Patch]: Remove dependency on
Utilities
by @MariusStorhaug in #74 - 🩹 [Patch]: Remove GITHUB_TOKEN environment variable, its already in the Github-Script by @MariusStorhaug in #75
- 🪲 [Fix]: Fix an issue with recent
IsNullOrEmpty
change by @MariusStorhaug in #76
Full Changelog: v1...v1.7.25
v1.7.24
What's Changed
Other Changes
- 🩹 [Patch]: Update output formatting by @MariusStorhaug in #73
Full Changelog: v1...v1.7.24
v1.7.23
What's Changed
Other Changes
- 🩹 [Patch]: Align default inputs and envvar naming by @MariusStorhaug in #71
Full Changelog: v1...v1.7.23
v1.7.22
What's Changed
Other Changes
- 🩹 [Patch]: Update linter config and clean up call to
main.ps1
by @MariusStorhaug in #70
Full Changelog: v1...v1.7.22