release-flow/Keep-a-Changelog Action

Performs operations on changelogs that are in Keep-a-Changelog format: bump the version, query release info.

Trust Signals

name	description	required	default
command	The command to perform: 'bump' or 'query'.	yes	—
changelog	The path to the changelog. If a relative path is specified, it is appended to the GitHub workspace path.	no	CHANGELOG.md
version	The release version. When bumping, determines the next version number. When querying, indicates the version for which to extract the release information. See readme for a full description and a list of special values.	yes	—
preid	The "prerelease identifier" to use as a prefix for the "prerelease" part of a semver. For example, it would specify the 'beta' in '1.0.0-beta.1'.	no	—
release-date	When bumping, indicates the release date that is written into the changelog for the new release, in ISO 8601 format, e.g. 2022-03-03. Defaults to the current system date.	no	—
tag-prefix	When bumping, specifies the prefix that is applied to the release number to generate the release tag.	no	v
output-file	When bumping, specifies the name of the modified changelog file relative to the input changelog directory. If not specified, the input changelog is overwritten.	no	—
keep-unreleased-section	When bumping, keeps an empty 'Unreleased' section in the output changelog after bumping the input changelog's 'Unreleased' section.	no	false
fail-on-empty-release-notes	When bumping, if this input is true then the action will report an error if it detects an empty 'Unreleased' section in the input changelog.	no	false

name	description
version	When bumping, contains the release version that was used to update the changelog. When querying, contains the release version that was matched.
release-notes	The markdown content of the changelog section for the release.
release-date	The release date in the form yyyy-MM-dd, or blank if the matched version was '[unreleased]'.
release-suffix	The final part of the release heading, after the version and date have been parsed. For example, if the release heading is '## [0.0.5] - 2014-12-13 [YANKED]', this output would contain '[YANKED]'.