release-drafter/Release Drafter

Draft release notes when pull requests merge into a branch.

View on GitHub

Trust Signals

Scorecard Score
Scorecard 4–6scored Jul 6, 2026
Maintenance Recency
Activelast commit Jul 11, 2026
License
ISC

Pinned Snippet

workflow.ymlSHA-pinned
uses: release-drafter/release-drafter@4d75298e00d9e34c483e5ff8c68d0ea1c1940c1e # v7.5.1

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

namedescriptionrequireddefault
config-nameRelease Drafter configuration target. A relative path starts in the repository's `.github` directory. norelease-drafter.yml
tokenAccess token for GitHub API requests. Default: github.token. ${{ github.token }}
nameRelease name. This value overrides `name-template`. no
tagRelease tag. This value overrides `tag-template`. no
versionRelease version. This value overrides the calculated version. no
fromRef, tag, branch, or commit SHA to use as the change comparison baseline. This value does not select the release version or the draft release to update. no
publishPublishes the created or updated release immediately. no""
latestMarks the created or updated release as latest. no""
prereleaseCreates a prerelease and includes changes since the previous prerelease when one exists. Default: `false`. no""
prerelease-identifierPrerelease identifier, such as `alpha`, `beta`, or `rc`. This input enables `prerelease`. no""
include-pre-releasesIncludes prereleases when Release Drafter selects the last published release. This input has no effect when `prerelease` is `true`. Default: `false`. no""
commitishRelease target. Use a branch, commit SHA, fully qualified tag, or pull request ref. Release Drafter resolves tag and pull request refs to commit SHAs. A pull request merge ref forces dry-run mode because its merge commit is temporary. Default: the workflow branch. no""
headerText to add before the template body. no""
footerText to add after the template body. no""
dry-runPrevents write operations. The action logs the proposed release operation. no""
filter-by-rangeFilter releases whose tag names satisfy this SemVer range. no""
namedescription
idThe ID of the release that was created or updated.
nameThe name of the release.
tag_nameThe name of the tag associated with the release.
bodyThe body of the drafted release.
html_urlThe URL for viewing the release.
upload_urlThe URL for uploading release assets.
major_versionThe major component of the resolved version.
minor_versionThe minor component of the resolved version.
patch_versionThe patch component of the resolved version.
resolved_versionThe resolved version number.