ConfigGenerator

Release Notes Generator

Generate professional GitHub release notes, CHANGELOG entries, and migration guides.

Release Metadata

The new semantic version tag.

Used for generating compare links.

Defaults to today if empty.

Name of the project.

Release Content

A brief overview of the release.

List of new capabilities.

List of resolved issues.

Important changes that break backward compatibility.

release-notes.md
1

Overview

Great release notes are crucial for developer experience and customer communication. This generator helps you structure professional Markdown release notes suitable for GitHub Releases, CHANGELOG.md files, or internal team deployment summaries. It separates features, bug fixes, breaking changes, and migration steps to ensure users know exactly what to expect when upgrading.

Automate your releases

You can generate release notes automatically in CI using tools like semantic-release, provided you use a Conventional Commit format →