Skip to content

v2.1.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 17 Jan 23:52
· 10 commits to main since this release
v2.1.0
ebbfeec
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

🚀 [Feature]: Add PR-based release name and notes options (#58)

The publish action now supports using your pull request title and description to create more meaningful GitHub releases, giving you control over how your module releases appear to users.

New action inputs

Three new inputs are available in the action:

Input Default Description
UsePRTitleAsReleaseName false Uses the pull request title as the name for the GitHub release
UsePRBodyAsReleaseNotes true Uses the pull request body as the release notes content
UsePRTitleAsNotesHeading true Prepends PR title as H1 heading with PR number link in release notes

Default behavior

With default settings, when a module is published:

  1. The release name uses the version tag (e.g., v1.2.3)
  2. The release notes include the PR title as a heading with a link to the PR
  3. The PR description follows as the release notes body
  4. Falls back to GitHub's auto-generated notes if the PR description is empty

Implementation details

The release creation logic in scripts/helpers/Publish-PSModule.ps1 now dynamically builds the gh release create command based on the configuration:

  • Adds --title with PR title when UsePRTitleAsReleaseName is enabled
  • Adds --notes with formatted content when PR body is available
  • Falls back to --generate-notes when no PR content is available

Linting improvements

  • Disabled BIOME_FORMAT validation via .github/PSModule.yml
  • Added persist-credentials: false to all checkout steps
  • Added groups configuration to dependabot for cooldown compliance
  • Added zizmor: ignore comments for intentional patterns (dangerous-triggers, unpinned external actions)
Assets 2
Loading