actions-marketplace-validations/Changelog Updater

Automatically update a CHANGELOG with the latest release notes.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stalelast commit Nov 16, 2024
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: actions-marketplace-validations/stefanzweifel_changelog-updater-action@b3a7ae7d4afc1d6982949a79bcd939fbcb245871 # no releases — HEAD as of 2026-07-10

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

Inputs

name	description	required	default
release-notes	The release notes you want to add to your CHANGELOG. Should be markdown. If not provided, the content between the Unreleased heading and the previous release heading is taken as release notes.	no	—
latest-version	Semantic version number of the latest release. The value will be used as a heading text.	yes	—
release-date	The date the latest version has been released. Defaults to the current date.	no	—
path-to-changelog	Defaults to `CHANGELOG.md`. Path to CHANGELOG.md file.	no	CHANGELOG.md
compare-url-target-revision	Target revision used in compare URL inside a possible "Unreleased" heading.	no	HEAD
heading-text	Text used in the new release heading. Defaults to the value from latest-version.	no	—
hide-release-date	Hide release date in the new release heading.	no	—
parse-github-usernames	Experimental: Find GitHub usernames in release notes and link to their profile.	no	—

Outputs

name	description
release_compare_url	The generated compare URL for the just created relase. For example https://github.com/org/repo/compare/v1.0.0...v1.1.0
release_url_fragment	The URL fragment for the just created release. For example '#v100---2021-02-01'. You can use this to generate URLs that point to the newly created release in your CHANGELOG.
unreleased_compare_url	The generated compare URL between the latest version and the target revision. For example https://github.com/org/repo/compare/v1.0.0...HEAD