LogPulse

LogPulse / templates

API changelog template

Use this fictional example as a starting point. Replace versions, dates, supported environments and behavior with tested facts from your release.

Example 1

A versioned release with concrete next steps

Improved

2.0.0 — 2026-06-10

Breaking changes

  • GET /events returns {items, next_cursor} instead of an array.

Migration

  1. Read records from response.items.
  2. Request the next page with cursor=next_cursor until null.
  3. Test empty and multi-page accounts.

Deprecated

  • page is deprecated; use cursor. Removal date is not yet scheduled.

Why it works: Names the changed surface and includes a verification action rather than asking consumers to infer the migration.

Copy the markdown · replace illustrative details
## 2.0.0 — 2026-06-10

### Breaking changes
- `GET /events` returns `{items, next_cursor}` instead of an array.

### Migration
1. Read records from `response.items`.
2. Request the next page with `cursor=next_cursor` until null.
3. Test empty and multi-page accounts.

### Deprecated
- `page` is deprecated; use `cursor`. Removal date is not yet scheduled.

What makes a great changelog?

  • Verify every command against the released artifact.
  • Publish versions and breaking changes as structured fields as well as readable markdown.
  • Keep unresolved removal dates explicitly undecided.

Keep reading

Common questions

Keep your writing toolkit close

Open-source changelog template →Developer tool changelog template →B2B SaaS release notes template →8 SaaS changelog examples worth borrowing →A release notes template you can actually reuse →Mobile app release notes without the guesswork →

Less setup. More shipping.

Give your next release an audience.

Up to 10 releases and 100 subscribers, with the ⚡ Powered by LogPulse badge. Pro is €12/month or €99/year.

Start freeTry the live widgetSee pricing