Changelog examples

This is the editor you will use, with sample data: the commits on the left, the two versions, and where it can be published.

Start free

acme/billing-app v3.2.0

Example
v3.2.0

Invoices you can search, and a faster dashboard

  • NewSearch every invoice from one box, by name, amount or number.
  • ImprovedThe dashboard loads about twice as fast.
  • FixedExports no longer cut off long names.

Then publish it

Hosted page

acme-billing.releasetale.com

A timeline with a page for each version and an RSS feed.

What’s new popup

“Invoice search is here”

Shown once per version on your own site with one script tag.

Markdown

CHANGELOG.md

Both versions in one file you can keep in your repository.

These examples are illustrative. Acme and its projects are fictional.

Changelog examples by project type: web app, API and mobile app

Below are three finished releases, one for each kind of project. Each is written twice: once for the people who use the product, and once for developers in the Keep a Changelog format. For the principles behind them, read our guide on how to write a changelog.

Web app: Invoices you can search, and a faster dashboard

For users

## Invoices you can search, and a faster dashboard (v3.2.0, 2026-11-10)

New
- Search every invoice from one box, by name, amount or number.

Improved
- The dashboard loads about twice as fast.

Fixed
- Exports no longer cut off long names.

For developers

## [3.2.0] - 2026-11-10

### Added
- GET /invoices/search and the global search box (#388)

### Changed
- Dashboard totals are cached for 60 seconds (#391)

### Fixed
- CSV export truncated billing_name at 32 characters (#395)

API and SDK: Refunds now notify you instantly

For users

## Refunds now notify you instantly (v1.4.0, 2026-11-10)

New
- Get a webhook the moment a refund completes.

Improved
- Payment retries are smoother when the service is busy.

Fixed
- A sync error that could stall your ledger is gone.

For developers

## [1.4.0] - 2026-11-10

### Added
- refund.completed webhook event (#412)

### Changed
- Client retries HTTP 429 with exponential backoff (#409)

### Fixed
- Nil pointer in ledger.Sync when the cursor is empty (#417)

Mobile app: Track runs without your phone

For users

## Track runs without your phone (v5.1.0, 2026-11-10)

New
- Start a run from your watch, no phone needed.
- A weekly summary arrives every Monday.

Fixed
- Distance stays accurate in tunnels, and the first-launch crash is gone.

For developers

## [5.1.0] - 2026-11-10

### Added
- Standalone WorkoutSession on watchOS (#204)
- Weekly summary local notification (#210)

### Fixed
- Location smoothing for low-accuracy fixes (#207) and the iOS 18 launch crash (#212)

What these changelog examples have in common

  • Every entry has a version and a date.
  • Changes are grouped by type, so readers can skip what does not concern them.
  • Each line describes the effect on the reader, not the code that changed.
  • Noise such as dependency bumps and lint updates is left out.
  • Developer entries link each change to its pull request. A breaking change would go first, with what to do about it.

Frequently asked questions

How do I write the same release for users and for developers?

Start from the same list of changes. For users, keep only what they can notice, group it under New, Improved and Fixed, and use plain words. For developers, list every notable change in the Keep a Changelog format, link each one to its pull request, and put any breaking change first.

Why does each release here have two versions?

Users and developers need different things from the same release. The user version explains what is new, and the developer version records what changed in the code, with a pull request for each change.

Can I copy these changelog examples?

Yes. Copy the structure and replace the details with your own. Acme and its projects are fictional, so do not reuse the names or version numbers.

Keep reading