Use Release Notes Generator

Enter your data below to use the Release Notes Generator

📌 Try these examples:
RESULT

Last updated

Conventional Commits Input

The generator processes commits following the conventional commits format:

feat: add dark mode support
feat: add CSV export to reports
fix: resolve login timeout on mobile
fix: correct tax calculation for EU orders
perf: reduce bundle size by 40% with code splitting
docs: update API authentication guide
BREAKING CHANGE: rename /api/v1/users to /api/v2/users

Generated Release Notes — v2.1.0

Full release notes generated from the commits above:

# Release Notes — v2.1.0
**Release Date:** March 17, 2026

## ⚠️ Breaking Changes

### API Endpoint Renamed
The `/api/v1/users` endpoint has been renamed to `/api/v2/users`.

**Migration Guide:**
Before:
```
GET /api/v1/users
```
After:
```
GET /api/v2/users
```
Update all API calls in your integration to use the new endpoint path.
The v1 endpoint will be removed in v3.0.0.

---

## ✨ New Features

### Dark Mode Support
The application now supports dark mode. Users can toggle between light and dark themes in Settings → Appearance. The preference is saved per account.

### CSV Export for Reports
All report views now include a "Export to CSV" button. Exported files include all visible columns and respect active filters.

---

## 🐛 Bug Fixes

- Fixed login timeout issue on mobile devices that caused users to be logged out after 5 minutes of inactivity
- Fixed incorrect tax calculation for orders shipped to EU countries with VAT

---

## ⚡ Performance Improvements

- Reduced JavaScript bundle size by 40% through code splitting. Initial page load time improved from ~3.2s to ~1.9s on a 4G connection.

---

## 📖 Documentation

- Updated API authentication guide with OAuth 2.0 examples and token refresh flow

---

## Upgrade Instructions

```bash
npm install my-app@2.1.0
```

See the [migration guide](#breaking-changes) for required code changes before upgrading.

Semantic Version Suggestion

The generator analyzes changes and suggests the correct version bump:

Changes detected:
  BREAKING CHANGE: 1 found → major version bump required
  feat: 2 found
  fix: 2 found
  perf: 1 found

Current version: 2.0.3
Suggested version: 3.0.0 (breaking change detected)

If breaking change is removed:
  Suggested version: 2.1.0 (new features, no breaking changes)

If only fixes:
  Suggested version: 2.0.4 (patch bump)

CHANGELOG.md Format (Keep a Changelog)

Generated CHANGELOG.md entry following the Keep a Changelog standard:

## [2.1.0] - 2026-03-17

### Added
- Dark mode support with per-account preference storage
- CSV export button on all report views

### Fixed
- Login timeout issue on mobile devices
- Incorrect tax calculation for EU orders

### Changed
- Renamed `/api/v1/users` to `/api/v2/users` (see migration guide)

### Performance
- Reduced JavaScript bundle size by 40% via code splitting

## [2.0.3] - 2026-02-28

### Fixed
- Minor UI alignment issue in the dashboard sidebar

User-Facing Announcement (Non-Technical)

Generated short announcement for a blog post or newsletter:

Subject: What's new in v2.1.0

We've shipped some improvements you've been asking for:

🌙 Dark mode is here — switch themes in Settings → Appearance
📊 Export any report to CSV with one click
🐛 Fixed login issues on mobile and tax calculation for EU orders
⚡ The app loads 40% faster on mobile connections

To upgrade, run: npm install my-app@2.1.0

Note: The /api/v1/users endpoint has been renamed. See the migration guide if you use our API directly.

GitHub Release Format

Generated release notes formatted for a GitHub release:

## What's Changed

### Breaking Changes
* Rename `/api/v1/users` to `/api/v2/users` by @dev-team in #234

### New Features
* Add dark mode support by @dev-team in #228
* Add CSV export to reports by @dev-team in #231

### Bug Fixes
* Fix login timeout on mobile by @dev-team in #235
* Fix EU tax calculation by @dev-team in #237

### Performance
* Reduce bundle size 40% with code splitting by @dev-team in #229

**Full Changelog:** https://github.com/org/repo/compare/v2.0.3...v2.1.0

Migration Guide for Breaking Change

Generated migration guide template for an API change:

## Migration Guide: v2.0.x → v2.1.0

### API Endpoint Rename

**Affected:** All integrations using the Users API

**Before (v2.0.x):**
```javascript
const response = await fetch('/api/v1/users');
```

**After (v2.1.0):**
```javascript
const response = await fetch('/api/v2/users');
```

**Steps:**
1. Search your codebase for `/api/v1/users`
2. Replace all occurrences with `/api/v2/users`
3. Test your integration against the staging environment
4. Deploy your updated integration

**Timeline:** The v1 endpoint will be removed in v3.0.0 (Q3 2026).

Examples

Patch Release Notes — v1.4.2

Minimal release notes for a bug-fix-only release:

# Release Notes — v1.4.2
**Release Date:** March 17, 2026

## Bug Fixes

- Fixed null pointer exception when user profile image is not set (#412)
- Fixed date picker not respecting timezone offset in Safari (#398)
- Fixed CSV import failing for files with Windows line endings (#405)

## Upgrade

```bash
npm install my-app@1.4.2
```

No breaking changes. Safe to upgrade from any 1.x version.

Frequently Asked Questions

Simply enter your data, click the process button, and get instant results. All processing happens in your browser for maximum privacy and security.

Yes! Release Notes Generator is completely free to use with no registration required. All processing is done client-side in your browser.

Absolutely! All processing happens locally in your browser. Your data never leaves your device, ensuring complete privacy and security.