release-drafter/Release Drafter
Draft release notes when pull requests merge into a branch.
View on GitHubTrust Signals
- Scorecard Score
- Scorecard 4–6scored Jul 6, 2026
- Maintenance Recency
- Activelast commit Jul 11, 2026
- License
- ISC
Pinned Snippet
uses: release-drafter/release-drafter@4d75298e00d9e34c483e5ff8c68d0ea1c1940c1e # v7.5.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| config-name | Release Drafter configuration target. A relative path starts in the repository's `.github` directory. | no | release-drafter.yml |
| token | Access token for GitHub API requests. Default: github.token. | — | ${{ github.token }} |
| name | Release name. This value overrides `name-template`. | no | — |
| tag | Release tag. This value overrides `tag-template`. | no | — |
| version | Release version. This value overrides the calculated version. | no | — |
| from | Ref, 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 | — |
| publish | Publishes the created or updated release immediately. | no | "" |
| latest | Marks the created or updated release as latest. | no | "" |
| prerelease | Creates a prerelease and includes changes since the previous prerelease when one exists. Default: `false`. | no | "" |
| prerelease-identifier | Prerelease identifier, such as `alpha`, `beta`, or `rc`. This input enables `prerelease`. | no | "" |
| include-pre-releases | Includes prereleases when Release Drafter selects the last published release. This input has no effect when `prerelease` is `true`. Default: `false`. | no | "" |
| commitish | Release 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 | "" |
| header | Text to add before the template body. | no | "" |
| footer | Text to add after the template body. | no | "" |
| dry-run | Prevents write operations. The action logs the proposed release operation. | no | "" |
| filter-by-range | Filter releases whose tag names satisfy this SemVer range. | no | "" |
Outputs
| name | description |
|---|---|
| id | The ID of the release that was created or updated. |
| name | The name of the release. |
| tag_name | The name of the tag associated with the release. |
| body | The body of the drafted release. |
| html_url | The URL for viewing the release. |
| upload_url | The URL for uploading release assets. |
| major_version | The major component of the resolved version. |
| minor_version | The minor component of the resolved version. |
| patch_version | The patch component of the resolved version. |
| resolved_version | The resolved version number. |