v2.2.2

🩹 [Patch]: Update Release workflow and dependencies (#61)

Updates the Release workflow and action configuration.

Changes

• Updated Release-GHRepository action to latest version
• Added comments to clarify workflow permissions
• Updated action configuration

v2.2.1

🩹[Patch]: Workflow improvements (#60)

This release makes several improvements to the release workflow and supporting scripts, focusing on standardization, clarity, and modernization. The most significant changes include renaming and updating the release workflow, consolidating and improving PowerShell scripts, and cleaning up configuration files related to linters and release notes. Additionally, the scripts now use Write-Host for output and include more structured and readable logging.

Release Workflow Improvements

• Renamed the workflow file from .github/workflows/Auto-Release.yml to .github/workflows/Release.yml, updated the workflow name and job names, and switched from the Auto-Release action to the newer Release-GHRepository action for publishing releases. Also, restricted the workflow to trigger only on changes to action.yml and src/**.

PowerShell Script Modernization and Consolidation

• Moved PowerShell scripts from the scripts/ directory to src/, updated references in action.yml, and improved script output by replacing Write-Output with Write-Host for better compatibility with GitHub Actions. Added more structured and visually separated log output using Write-Host '-------------------------------------------------'.

Configuration and Linting Cleanup

• Removed the .github/linters/.jscpd.json configuration file and disabled JSCPD validation in the linter workflow.
• Added an exclusion for the PSAvoidUsingWriteHost rule in .github/linters/.powershell-psscriptanalyzer.psd1 to allow using Write-Host in scripts running on GitHub Actions.

Release Notes and Input Documentation

• Removed the custom changelog configuration from .github/release.yml to rely on default GitHub release note generation.
• Fixed a typo in the IncrementalPrerelease input description in action.yml.

v2.2.0

🚀 [Feature]: Add ReleaseType input for explicit release control (#59)

The action now supports explicit control over the release type through the new ReleaseType input parameter. You can specify whether to create a stable release, prerelease, or skip releasing entirely—without relying on automatic detection from PR state and labels. The workflow has also been restructured into three phases (initialization, publishing, cleanup) that run conditionally, improving efficiency when only cleanup is needed.

• Part of PSModule/Process-PSModule#73
• Fixes PSModule/Process-PSModule#265

New ReleaseType input parameter

A new ReleaseType input allows you to explicitly control the release behavior:

Value	Description
Release	Create a stable release (default)
Prerelease	Create a prerelease
None	Do not create any release

This input is designed to work with Get-PSModuleSettings, which pre-calculates the appropriate release type based on your workflow context:

- uses: PSModule/Publish-PSModule@v2
  with:
    APIKey: ${{ secrets.PSGALLERY_API_KEY }}
    ReleaseType: ${{ fromJson(inputs.Settings).Publish.Module.ReleaseType }}
    AutoCleanup: ${{ fromJson(inputs.Settings).Publish.Module.AutoCleanup }}

Restructured workflow execution

The action now runs in three separate phases, each executing only when needed:

1. Initialize Publish Context (init.ps1) – Calculates version, validates inputs, and stores context in environment variables
2. Publish Module (publish.ps1) – Downloads artifact, updates manifest, publishes to PSGallery, and creates GitHub release (runs only when ShouldPublish is true)
3. Cleanup Prereleases (cleanup.ps1) – Deletes old prerelease tags (runs only when ShouldCleanup is true)

This separation means the action skips unnecessary steps. For example, when a PR is closed without merging, the workflow can run cleanup independently without downloading artifacts or attempting to publish.

Backward compatibility

The ReleaseType parameter defaults to Release, maintaining current behavior for merged PRs targeting the default branch. Existing workflows continue to work without modification.

v2.1.0

🚀 [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.

• Relates to PSModule/Process-PSModule#263

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)

v2.0.8

Bump actions/checkout from 5 to 6 (#57)

Bumps actions/checkout from 5 to 6.

Release notes

Sourced from actions/checkout's releases.

v6.0.0

What's Changed

• Update README to include Node.js 24 support details and requirements by @​salmanmkc in actions/checkout#2248
• Persist creds to a separate file by @​ericsciple in actions/checkout#2286
• v6-beta by @​ericsciple in actions/checkout#2298
• update readme/changelog for v6 by @​ericsciple in actions/checkout#2311

Full Changelog: actions/checkout@v5.0.0...v6.0.0

v6-beta

What's Changed

Updated persist-credentials to store the credentials under $RUNNER_TEMP instead of directly in the local git config.

This requires a minimum Actions Runner version of v2.329.0 to access the persisted credentials for Docker container action scenarios.

v5.0.1

What's Changed

• Port v6 cleanup to v5 by @​ericsciple in actions/checkout#2301

Full Changelog: actions/checkout@v5...v5.0.1

Changelog

Sourced from actions/checkout's changelog.

Changelog

V6.0.0

• Persist creds to a separate file by @​ericsciple in actions/checkout#2286
• Update README to include Node.js 24 support details and requirements by @​salmanmkc in actions/checkout#2248

V5.0.1

• Port v6 cleanup to v5 by @​ericsciple in actions/checkout#2301

V5.0.0

• Update actions checkout to use node 24 by @​salmanmkc in actions/checkout#2226

V4.3.1

• Port v6 cleanup to v4 by @​ericsciple in actions/checkout#2305

V4.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#2236

v4.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#1946

v4.2.1

• Check out other refs/* by commit if provided, fall back to ref by @​orhantoy in actions/checkout#1924

v4.2.0

• Add Ref and Commit outputs by @​lucacome in actions/checkout#1180
• Dependency updates by @​dependabot- actions/checkout#1777, actions/checkout#1872

v4.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#1776

v4.1.6

• Check platform to set archive extension appropriately by @​cory-miller in actions/checkout#1732

v4.1.5

• Update NPM dependencies by @​cory-miller in actions/checkout#1703
• Bump github/codeql-action from 2 to 3 by @​dependabot in actions/checkout#1694
• Bump actions/setup-node from 1 to 4 by @​dependabot in actions/checkout#1696
• Bump actions/upload-artifact from 2 to 4 by @​dependabot in actions/checkout#1695

... (truncated)

Commits

• 1af3b93 update readme/changelog for v6 (#2311)
• 71cf226 v6-beta (#2298)
• 069c695 Persist creds to a separate file (#2286)
• ff7abcd Update README to include Node.js 24 support details and requirements (#2248)
• See full diff in compare view

[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-d...

v2.0.7

🩹 [Patch]: Move documentation and link to Process-PSModule (#56)

Description

This pull request primarily cleans up and simplifies the documentation and metadata for the Publish-PSModule GitHub Action. The most significant changes involve removing detailed usage instructions and specifications from the README.md, and simplifying the action's metadata in action.yml.

Documentation cleanup and simplification:

• The README.md file has been heavily reduced, removing detailed descriptions, usage instructions, configuration options, and example workflows, leaving only a brief reference to the PSModule framework.

Metadata update:

• The action.yml file has been simplified by removing branding information and shortening the action's name.

v2.0.6

🩹 [Patch]: Encode all PowerShell files using UTF8 with BOM (#55)

Description

This pull request makes a minor change to the scripts/main.ps1 file. It updates the file to include a Unicode Byte Order Mark (BOM) at the beginning, which can help with encoding detection in some editors and environments.

v2.0.5

🩹 [Patch]: Update Dependabot configuration to include labels for GitHub Actions (#54)

Description

This pull request makes a small configuration update to the Dependabot settings. It adds labels to automatically categorize pull requests related to GitHub Actions dependencies.

• .github/dependabot.yml: Added dependencies and github-actions labels to GitHub Actions update PRs.

v2.0.4

Bump actions/checkout from 4 to 5 (#53)

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 Version

v2.327.1
Release Notes

Make 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#2237

New 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#2236

Full 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#1946

Full 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#1924

New Contributors

• @​Jcambass made their first contribution in actions/checkout#1919

Full 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#2226

V4.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#2236

v4.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#1946

v4.2.1

• Check out other refs/* by commit if provided, fall back to ref by @​orhantoy in actions/checkout#1924

v4.2.0

• Add Ref and Commit outputs by @​lucacome in actions/checkout#1180
• Dependency updates by @​dependabot- actions/checkout#1777, actions/checkout#1872

v4.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#1776

v4.1.6

• Check platform to set archive extension appropriately by @​cory-miller in actions/checkout#1732

v4.1.5

• Update NPM dependencie...

v2.0.3

📖 [Docs]: Remove unused configuration options from README (#52)

Description

This pull request updates the README.md file to simplify the list of configurable settings for the action. It removes several less commonly used settings to streamline the documentation and make it easier to read.

Documentation cleanup:

• README.md: Removed the following settings from the configuration list: Debug, Verbose, Version, and Prerelease. These settings are no longer included in the documentation to simplify the list and focus on the most relevant options.

Type of change

• 📖 [Docs]
• 🪲 [Fix]
• 🩹 [Patch]
• ⚠️ [Security fix]
• 🚀 [Feature]
• 🌟 [Breaking change]

Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas