Release Notes Generator

DK
@David Kim
4 days ago
Fork

Generate release notes for {{product_name}} version {{version}}.

Release Details

  • Release Date: {{release_date}}
  • Audience: {{audience}}

Changes

New Features

{{new_features}}

Improvements

{{improvements}}

Bug Fixes

{{bug_fixes}}

Breaking Changes (if any)

{{breaking_changes}}


Release Notes Structure

Header

## {{product_name}} {{version}} Release Notes
Released: {{release_date}}

Highlights

3-5 sentence summary of the most impactful changes. Make it exciting!

What's New

For each new feature:

  • Feature Name: Brief description
  • Why it matters to users
  • How to use it (one line)
  • Screenshot/GIF placeholder suggestion

Improvements

Bullet list with:

  • What improved
  • Before vs. after (if applicable)

Bug Fixes

  • Concise bullet points
  • Include issue IDs if public

Breaking Changes

For each:

  • What changed
  • Why
  • Migration steps
  • Deadline (if deprecation)

Upgrading

  • How to upgrade
  • Recommended steps
  • Rollback instructions

Known Issues

  • Any issues in this release
  • Workarounds
  • Fix timeline

Thank You

  • Acknowledge contributors
  • Link to changelog
  • Feedback channel

Additional Versions

Short Version (for email/social)

2-3 sentences + key bullets

Technical Changelog

Developer-focused, git-log style

Variables 8

Product Name {{product_name}}
e.g., Promptlyb
Version {{version}}
e.g., 2.5.0, v3.0
Release Date {{release_date}}
e.g., December 2, 2024
Audience {{audience}}
e.g., End users, Developers, Both
New Features {{new_features}}
List each new feature on a new line...
Improvements {{improvements}}
List each improvement on a new line...
Bug Fixes {{bug_fixes}}
List each bug fix on a new line...
Breaking Changes {{breaking_changes}}
List any breaking changes, or write "None"