psmodule/Release GHRepository (by PSModule)

Automatically creates releases based on pull requests and labels.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jul 10, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: psmodule/release-ghrepository@750abed0ecab02394554b610dc3aa191e75e3248 # v2.0.3

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
AutoCleanupControl whether to automatically delete the prerelease tags after the stable release is created.notrue
AutoPatchingControl whether to automatically handle patches. If disabled, the action will only create a patch release if the pull request has a 'patch' label.notrue
ConfigurationFileThe path to the configuration file. Settings in the configuration file take precedence over the action inputs.no.github\auto-release.yml
CreateMajorTagControl whether to create a major tag when a pull request is merged into the main branch.notrue
CreateMinorTagControl whether to create a minor tag when a pull request is merged into the main branch.notrue
DatePrereleaseFormatIf specified, uses a date based prerelease scheme. The format should be a valid .NET format string like 'yyyyMMddHHmm'.no""
IgnoreLabelsA comma separated list of labels that do not trigger a release.noNoRelease
IncrementalPrereleaseControl whether to automatically increment the prerelease number. If disabled, the action will ensure only one prerelease exists for a given branch.notrue
MajorLabelsA comma separated list of labels that trigger a major release.nomajor, breaking
MinorLabelsA comma separated list of labels that trigger a minor release.nominor, feature
PatchLabelsA comma separated list of labels that trigger a patch release.nopatch, fix
UsePRTitleAsReleaseNameWhen enabled, uses the pull request title as the name for the GitHub release.nofalse
UsePRBodyAsReleaseNotesWhen enabled, uses the pull request body as the release notes for the GitHub release.notrue
UsePRTitleAsNotesHeadingWhen enabled, the release notes will begin with the pull request title as a H1 heading followed by the pull request body. The title will reference the pull request number.notrue
VersionPrefixThe prefix to use for the version number.nov
WhatIfIf specified, the action will only log the changes it would make, but will not actually create or delete any releases or tags.nofalse
DebugEnable debug output.nofalse
VerboseEnable verbose output.nofalse
VersionSpecifies the version of the GitHub module to be installed. Accepts an exact version or a NuGet version range (for example '[1.2.0, 2.0.0)').no
PrereleaseAllow prerelease versions if available.nofalse
WorkingDirectoryThe working directory where the script will run from.no${{ github.workspace }}

no outputs