so1omon563/Release Creator

Creates a GitHub Release with auto-generated release notes from conventional commit history. Supports grouped, conventional, flat, and GitHub-native note formats. Works standalone or chained with custom-semver-bumper.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
tagThe tag name for the release (e.g. v1.2.3). Required unless the workflow is triggered by a tag push, in which case the tag is inferred from github.ref_name.no""
tokenGitHub token used to create the release and upload assets. Must have contents: write permission.yes
release-nameDisplay name for the release. Defaults to the tag name when not provided.no""
bodyExplicit release body text. When provided, overrides auto-generated notes.no""
draftCreate the release as a draft (not published).nofalse
prereleaseMark the release as a pre-release. When set to 'auto', the tag name is inspected for a SemVer §9 pre-release identifier — any hyphen-separated label immediately after the patch version is treated as a pre-release (e.g. -alpha.1, -rc.2, -enterprise.1, -team-blue.3). Tags with SemVer §10 build metadata only (e.g. v1.2.3+sha.abc) are treated as stable. Set to 'true' or 'false' to override auto-detection.noauto
target-commitishSpecifies the commitish value that the tag is created from. Defaults to the repository default branch.no""
notes-formatFormat for auto-generated release notes. Ignored when body is provided. Options: grouped (emoji section headers), conventional (flat list with type prefix), flat (plain commit messages), github-native (delegate to GitHub's built-in release notes generator).nogrouped
from-tagStart of the commit range used for release note generation (exclusive). Typically the previous release tag. When omitted, the action uses the tag immediately preceding the to-tag.no""
to-tagEnd of the commit range used for release note generation (inclusive). Defaults to the value of the tag input.no""
asset-pathsNewline-separated list of glob patterns for files to upload as release assets. Each pattern is expanded relative to the workspace root.no""
skip-if-release-existsWhen true, the action exits successfully without creating a release if one already exists for the given tag. The skipped output is set to true.nofalse
path-filterLimit release notes to commits that touch files under this path. Useful for monorepos. Accepts a single directory or file path.no""
tag-prefixPrefix to strip when comparing version numbers (e.g. v for tags like v1.2.3). Used during pre-release auto-detection and version comparisons. When chaining with custom-semver-bumper, set this to match the bumper's tag_prefix input (default: v).no""
fail-on-errorWhen true, the action fails if release creation or asset upload encounters an error. When false, errors are logged and the action exits successfully with created=false.notrue
move-major-tagMove the major floating pointer tag (e.g. v1) to point to the commit this release was created from. Skipped automatically when the release is detected as a pre-release — floating pointer tags must only ever reference stable commits.nofalse
move-minor-tagMove the minor floating pointer tag (e.g. v1.3) to point to the commit this release was created from. Skipped automatically when the release is detected as a pre-release — same reason as move-major-tag.nofalse
namedescription
release-urlHTML URL of the created GitHub Release.
release-idNumeric ID of the created GitHub Release.
upload-urlUpload URL template for attaching additional assets to the release after the action completes.
tag-nameThe tag name used for the release.
createdSet to true when a new release was created, false when creation was skipped or failed (with fail-on-error: false).
skippedSet to true when skip-if-release-exists is true and a release already exists for the given tag.