Changelog badge, for your README.
Paste a public GitHub repository. The badge checks its CHANGELOG.md against Keep a Changelog 2.0.0 and links to a report with a fix for every issue, so users see the changelog is kept and contributors see what to fix.
What it says
One word for the state of your changelog.
Click the badge in a README and you land on the report: every finding with its line number and a one-sentence fix.
No errors or warnings: the file follows Keep a Changelog.
Only warnings. The file still parses; fix them for a green badge.
At least one error, such as a date that isn't YYYY-MM-DD or a heading at the wrong level.
The repository exists but has no CHANGELOG.md (or CHANGES.md, HISTORY.md…) on its default branch.
GitHub didn't answer in time. It tries again within minutes.
Something else?
“repo not found” means there's no public repository by that name — check the spelling in the badge's address.
How it works
Reads your changelog the way a visitor would.
- Your default branchThe first of CHANGELOG.md, CHANGES.md, HISTORY.md, changelog.md, RELEASES.md, NEWS.md it finds, read straight from GitHub's public file server, up to 1 MB.
- The validator's own checkThe same rules as the changelog validator, so the badge and the report never disagree with it.
- Refreshed about every 6 hoursOne check serves every view in between, so a busy README costs GitHub almost nothing.
- Nothing to sign up forNo account, no key, no cookies. Showing the badge isn't counted or stored.
- Keep it green in CIAdd the free CI step and a broken changelog is flagged in the pull request, before the badge sees it.
Add it by hand
Replace OWNER and REPO with your repository, exactly as in its GitHub address, and put the line under your README's title.
[](https://release-ripple-roadmap.lovable.app/changelog-check/OWNER/REPO)<a href="https://release-ripple-roadmap.lovable.app/changelog-check/OWNER/REPO"><img src="https://release-ripple-roadmap.lovable.app/badge/github/OWNER/REPO.svg" alt="Changelog"></a>.. image:: https://release-ripple-roadmap.lovable.app/badge/github/OWNER/REPO.svg
:target: https://release-ripple-roadmap.lovable.app/changelog-check/OWNER/REPO
:alt: ChangelogThe format behind it
Keep a Changelog, in a minute
What the badge checks, from Keep a Changelog 2.0.0, the current version of the format (published 7 June 2026).
Keep a Changelog defines a changelog as a curated, chronologically ordered list of the notable changes for each version of a project
. Its guiding principles: changelogs are for humans, not machines; every version gets an entry; changes of the same type are grouped; versions and sections are linkable; the latest version comes first; each version shows its release date; and the file says which versioning scheme it uses.
Changes go under six types: Added, Changed, Deprecated, Removed, Fixed, Security. There are only six on purpose, so every changelog reads — and parses — the same way.
An Unreleased section at the top collects what's coming. Each version starts with its number and date, like ## [1.0.0] - 2017-07-17, with the date written YYYY-MM-DD (the ISO 8601 order, largest unit first). The bracketed version is a link, resolved at the bottom of the file to the comparison with the version before.
Version 2.0.0 “breaks the guidance, not the format”: the six types, the dates and the Unreleased and [YANKED] markers are unchanged. The main change for files is how breaking changes are marked — with a **Breaking:** marker on the entry, inside its type, instead of a separate section. The file should be called CHANGELOG.md.
Want the long version? Read the changelog format, explained or start from the changelog template.