Create a Keep a Changelog entry

Create a Keep a Changelog release entry with categorized Markdown changes.

freeworks offlinenothing uploaded
ToolChangelog Generator
Input
Output
—

How it works

The version and date are inserted under a release heading, and categorized lists become Markdown bullets. Optional comparison links use the supplied repository URLs.

  • Keep a Changelog categories separate user-visible change types.
  • Release timing remains editable rather than assumed.

Worked example

Generate a changelog entry
Create a Keep a Changelog formatted version entry
Input
											Version: 1.2.0
Date: 2024-03-15
Changes: {"added":["Dark mode support","Export to PDF"],"fixed":["Login timeout issue"]}
Output
												## [1.2.0] - 2024-03-15

### Added

- Dark mode support
- Export to PDF

### Fixed

- Login timeout issue

When to use this

Library repositories, release scripts, and package registries publish these entries.

Edge cases

  • An empty category produces no fabricated bullet.
  • Markdown punctuation in a version can alter the heading.
  • Comparison links need valid tag URLs to be useful.

References