Skip to main content
Back to Dev generators

Dev

Changelog Entry Generator

A CHANGELOG.md that drifts between formats is harder to read and harder to parse with tooling than no changelog at all. This generator produces a correctly structured entry in the Keep a Changelog format every time, so your project history stays consistent. Fill in three fields: the version number, the change type — Added, Changed, Fixed, Removed, Deprecated, or Security — and a short description. The generator returns a versioned, dated Markdown block with an H2 heading, an H3 subheading for the change type, and your description as a bullet point. Paste the output at the top of your CHANGELOG.md, above older entries. To record multiple changes for the same version, generate an entry for each type and merge the bullets under the shared version heading. Update the hardcoded date to the actual release date before committing.

Read the complete guide — 4 min read

How to use

  1. Choose your options above
  2. Click Generate
  3. Copy your result

Detailed instructions

  1. Enter the version number.
  2. Pick the type of change.
  3. Describe the change in a short sentence.
  4. Click Generate, then paste the entry at the top of your changelog.

Use Cases

  • Adding a release note to a CHANGELOG.md file
  • Keeping changelog formatting consistent across versions
  • Remembering the standard Keep a Changelog categories
  • Drafting release notes during a version bump
  • Teaching a team how to document changes

Tips

  • Keep the newest version entry at the top of the file.
  • Use one category heading per change type within a version.
  • Write descriptions from the user's perspective, not the code's.
  • Flag breaking changes clearly so upgraders notice them.

FAQ

what is the keep a changelog format

A widely adopted convention where each release gets an H2 heading with the version and date, and changes are grouped under H3 subheadings by category: Added, Changed, Fixed, Removed, Deprecated, and Security. It keeps changelogs human-readable and machine-parseable.

can I record multiple changes in one version entry

The generator produces one category block per run. To record multiple changes, generate an entry for each change type separately, then merge the bullets under the same H2 version heading in your file.

why group changes by type

Grouping lets readers jump to what matters — new features under Added, bug fixes under Fixed, breaking changes under Removed or Deprecated. Tools that parse changelogs to generate release notes also rely on this structure.

which change types are supported

The six standard Keep a Changelog categories: Added, Changed, Fixed, Removed, Deprecated, and Security. Any value not in this list defaults to Added. Use Security for vulnerability patches so consumers can identify them immediately.

You might also like

Popular tools from other categories that share themes with this one.

Try these next

More free tools from other corners of the catalog, picked by shared themes.