Free tool, no signup

Turn your CHANGELOG.md into a public changelog page

Paste a GitHub repo or a raw CHANGELOG.md link and see it as a changelog page your users can read. It's free and you don't need an account.

Try olivierlacan/keep-a-changelog. Public repos only.

No releases or CHANGELOG.md? Paste your commits.

New to the format? Read our Keep a Changelog guide.

Captain's log preview

olivierlacan/keep-a-changelog

16 versions from CHANGELOG.md, newest first.

Host it on ShipLog for free

Create a free account and we import these entries into your first project, so the page is live in about a minute. The free plan keeps 10 entries. Captain is $9 a month per project and keeps everything.

The free plan imports the newest 10 of these 16 versions. The other 6 need Captain.

Host this changelog free
  1. 2.0.0

    2.0.0 is the first major revision of Keep a Changelog. It breaks the guidance, not the format: the six change types, YYYY-MM-DD dates, and the Unreleased and [YANKED] markers are all unchanged, so your existing changelog stays valid. What breaks is the surface around it. The page is restructured so some older section links no longer resolve, the recommended guidance has shifted, and existing translations are out of date until they catch up. The breaking changes are marked below.

    Removed

    • Outdated specifics (the Vandamme gem reference and a GitHub-Releases discoverability note) in favor of more general guidance.
    • Breaking: The FAQ scaffolding and most first-person framing, whose section anchors no longer resolve; the podcast note now lives in the References section.

    Changed

    • Breaking: Retired the tagline "Don't let your friends dump git logs into changelogs" for "Clearly document the evolution of your projects." Earlier versions keep the original.
    • Breaking: Restructured the page from a flat FAQ into integrated guidance, in a plainer, less first-person voice. Some older section links no longer resolve.
    • Reframed the "GitHub Releases" answer as "Is a changelog the same as release notes?", broadened beyond GitHub to any host.
    • Set page titles and descriptions from frontmatter, and fixed OpenGraph metadata so shared links render correctly and language-appropriately.

    Added

    • New guidance answering long-standing community questions:
      • Format: the # Changelog header preamble, and adopting a newer version of the format without rewriting history; marking breaking changes and where upgrade steps belong; naming which part of the project an entry touches; choosing between Changed, Fixed, and Security; leading a Security entry with its CVE and pointing it to the full advisory; why the six change types don't grow, and a recommended order for them.
      • Versioning: schemes beyond SemVer, and linking each version to a compare diff with reference links.
      • Changelogs vs. release notes: how to derive one from the other without duplicate work, and why a host's generated notes are vendor lock-in.
      • Automation: LLM-drafted changelogs with a brief for an AGENTS.md; Conventional Commits; CI/CD; linking issues and pull requests; crediting contributors.
      • Scale: very large changelogs and monorepos.
      • Optional per-release summaries, and a statement of what Keep a Changelog deliberately won't do.
    • A redesigned, accessible site (WCAG 2.1 AA) with light and dark themes.
  2. 1.1.2

    Added

    • v1.1 German translation.
    • v1.1 Italian translation.
    • v1.1 Simplified Chinese translation.
    • v1.1 Persian translation.
    • v1.1 Polish translation.
    • v1.1 Slovenian translation.
    • v1.1 Traditional Chinese translation.
    • v1.1 Spanish translation.
    • v1.1 Brazilian Portuguese translation.
    • v1.1 Czech translation.
    • v1.1 Romanian translation.
    • v1.1 Swedish translation.
    • v1.1 Ukrainian translation.
    • v1.1 Korean translation.
    • v1.1 Indonesian translation.

    Fixed

    • Improve French translation.
    • Improve Dutch translation.
  3. 1.1.1

    Added

    • v1.1 Arabic translation.
    • v1.1 French translation.
    • v1.1 Dutch translation.
    • v1.1 Russian translation.
    • v1.1 Japanese translation.
    • v1.1 Norwegian Bokmål translation.
    • v1.1 "Inconsistent Changes" Turkish translation.
    • Default to most recent versions available for each languages.
    • Display count of available translations (26 to date!).
    • Centralize all links into /data/links.json so they can be updated easily.

    Fixed

    • Improve French translation.
    • Improve id-ID translation.
    • Improve Persian translation.
    • Improve Russian translation.
    • Improve Swedish title.
    • Improve zh-CN translation.
    • Improve French translation.
    • Improve zh-TW translation.
    • Improve Spanish (es-ES) transltion.
    • Foldout menu in Dutch translation.
    • Missing periods at the end of each change.
    • Fix missing logo in 1.1 pages.
    • Display notice when translation isn't for most recent version.
    • Various broken links, page versions, and indentations.

    Changed

    • Upgrade dependencies: Ruby 3.2.1, Middleman, etc.

    Removed

    • Unused normalize.css file.
    • Identical links assigned in each translation file.
    • Duplicate index file for the english version.
  4. 1.1.0

    Added

    • Danish translation.
    • Georgian translation from.
    • Changelog inconsistency section in Bad Practices.

    Fixed

    • Italian translation.
    • Indonesian translation.
  5. 1.0.0

    Added

    • New visual identity by @tylerfortune8.
    • Version navigation.
    • Links to latest released version in previous versions.
    • "Why keep a changelog?" section.
    • "Who needs a changelog?" section.
    • "How do I make a changelog?" section.
    • "Frequently Asked Questions" section.
    • New "Guiding Principles" sub-section to "How do I make a changelog?".
    • Simplified and Traditional Chinese translations from @tianshuo.
    • German translation from @mpbzh & @Art4.
    • Italian translation from @azkidenz.
    • Swedish translation from @magol.
    • Turkish translation from @emreerkan.
    • French translation from @zapashcanon.
    • Brazilian Portuguese translation from @Webysther.
    • Polish translation from @amielucha & @m-aciek.
    • Russian translation from @aishek.
    • Czech translation from @h4vry.
    • Slovak translation from @jkostolansky.
    • Korean translation from @pierceh89.
    • Croatian translation from @porx.
    • Persian translation from @Hameds.
    • Ukrainian translation from @osadchyi-s.

    Changed

    • Start using "changelog" over "change log" since it's the common usage.
    • Start versioning based on the current English version at 0.3.0 to help translation authors keep things up-to-date.
    • Rewrite "What makes unicorns cry?" section.
    • Rewrite "Ignoring Deprecations" sub-section to clarify the ideal scenario.
    • Improve "Commit log diffs" sub-section to further argument against them.
    • Merge "Why can’t people just use a git log diff?" with "Commit log diffs".
    • Fix typos in Simplified Chinese and Traditional Chinese translations.
    • Fix typos in Brazilian Portuguese translation.
    • Fix typos in Turkish translation.
    • Fix typos in Czech translation.
    • Fix typos in Swedish translation.
    • Improve phrasing in French translation.
    • Fix phrasing and spelling in German translation.

    Removed

    • Section about "changelog" vs "CHANGELOG".
  6. 0.3.0

    Added

  7. 0.2.0

    Changed

    • Remove exclusionary mentions of "open source" since this project can benefit both "open" and "closed" source projects equally.
  8. 0.1.0

    Added

    • Answer "Should you ever rewrite a change log?".

    Changed

    • Improve argument against commit logs.
    • Start following SemVer properly.
  9. 0.0.8

    Changed

    • Update year to match in every README example.
    • Reluctantly stop making fun of Brits only, since most of the world writes dates in a strange way.

    Fixed

    • Fix typos in recent README changes.
    • Update outdated unreleased diff link.
  10. 0.0.7

    Added

    • Link, and make it obvious that date format is ISO 8601.

    Changed

    • Clarified the section on "Is there a standard change log format?".

    Fixed

    • Fix Markdown links to tag comparison URL with footnote-style links.
  11. 0.0.6

    Added

    • README section on "yanked" releases.
  12. 0.0.5

    Added

    • Markdown links to version tags on release headings.
    • Unreleased section to gather unreleased changes and encourage note keeping prior to releases.
  13. 0.0.4

    Added

    • Better explanation of the difference between the file ("CHANGELOG") and its function "the change log".

    Changed

    • Refer to a "change log" instead of a "CHANGELOG" throughout the site to differentiate between the file and the purpose of the file — the logging of changes.

    Removed

    • Remove empty sections from CHANGELOG, they occupy too much space and create too much noise in the file. People will have to assume that the missing sections were intentionally left out because they contained no notable changes.
  14. 0.0.3

    Added

    • "Why should I care?" section mentioning The Changelog podcast.
  15. 0.0.2

    Added

    • Explanation of the recommended reverse chronological release ordering.
  16. 0.0.1

    Added

    • This CHANGELOG file to hopefully serve as an evolving example of a standardized open source project CHANGELOG.
    • CNAME file to enable GitHub Pages custom domain.
    • README now contains answers to common questions about CHANGELOGs.
    • Good examples and basic guidelines, including proper date formatting.
    • Counter-examples: "What makes unicorns cry?".

How it works

We fetch the CHANGELOG.md from the repo's default branch, split it into one entry per version heading, and keep your dates, sections and links. Files that follow the Keep a Changelog format come out with Added, Changed and Fixed groups intact. Other markdown changelogs work too, as long as each release starts with a heading.

Why bother

Most teams write a CHANGELOG.md for contributors. Most of your users will never open the repo, so the work you put into release notes stops at GitHub. A hosted page gives them a link they can bookmark and a feed they can follow, and the same entries can show up in a What's New tab inside your app.

Questions

Does it change my repo?
No. We only read the public file and never write back to GitHub.
What if my repo uses GitHub Releases instead?
Use the GitHub releases tool, which reads your releases instead of a file.
Will it stay in sync?
The preview is a one-time read. Once you host it, you can add new entries in ShipLog or publish them from your release workflow.