step-security/Release Drafter

Drafts your next release notes as pull requests are merged into your branch(es).

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
config-nameIf your workflow requires multiple release-drafter configs it be helpful to override the config-name. The config should still be located inside `.github` as that's where we are looking for config files. norelease-drafter.yml
tokenAccess token used to make requests against the GitHub API. Defaults to github.token. ${{ github.token }}
nameThe name that will be used in the GitHub release that's created or updated. This will override any `name-template` specified in your `release-drafter.yml` if defined. no
tagThe tag name to be associated with the GitHub release that's created or updated. This will override any `tag-template` specified in your `release-drafter.yml` if defined. no
versionThe version to be associated with the GitHub release that's created or updated. This will override any version calculated by the release-drafter. no
publishA boolean indicating whether the release being created or updated should be immediately published. no""
latestA boolean indicating whether the release being created or updated should be marked as latest. no""
prereleaseWhether to draft a prerelease, with changes since another prerelease (if applicable). Default `false`. no""
prerelease-identifierA string indicating an identifier (alpha, beta, rc, etc), to increment the prerelease version. This automatically enables `prerelease` when both values come from the same config location; explicit action inputs still take precedence. no""
include-pre-releasesWhen looking for the last published release to scan changes up-to, include pre-releases. Has no effect if using `prerelease: true` (already enabled). Default `false`. no""
commitishThe release target, i.e. branch or commit it should point to. Default: the ref that release-drafter runs for, e.g. `refs/heads/master` if configured to run on pushes to `master`. no""
headerA string that would be added before the template body. no""
footerA string that would be added after the template body. no""
dry-runA boolean indicating whether to run without performing any write operations. When enabled, the action logs what it would have done instead of creating or updating releases. no""
filter-by-rangeFilter releases that satisfies this semver range. Evaluates the tag name againts node's semver.satisfies(). 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 users can navigate to in order to view the release
upload_urlThe URL for uploading assets to the release, which could be used by GitHub Actions for additional uses, for example the @actions/upload-release-asset GitHub Action.
major_versionThe next major version number. For example, if the last tag or release was v1.2.3, the value would be v2.0.0.
minor_versionThe next minor version number. For example, if the last tag or release was v1.2.3, the value would be v1.3.0.
patch_versionThe next patch version number. For example, if the last tag or release was v1.2.3, the value would be v1.2.4.
resolved_versionThe next resolved version number, based on GitHub labels.