The Problem

Developers write conventional or messy Git commit messages (fix(auth): handle null token check, feat(billing): add paystack webhook, chore: bump deps). However, your customers, product managers, and users need clean, categorized, and visually polished Release Notes.

Writing changelogs manually is tedious, prone to omissions, and delays product shipping.

ReleaseNote Studio automates this entirely.

✨ Features

| Feature | Description | |---------|-------------| | ⚡ Conventional Commits Parser | Auto-detects feat, fix, perf, security, docs, and breaking changes (!:) | | 🧠 Jargon Humanizer | Replaces dev shortcuts (auth → Authentication, ui → User Interface) with polished prose | | ✨ In-App SaaS Widget | Generate a drop-in HTML/JS "What's New" modal with an unread version badge | | 📄 Multi-Format Export | Export to Markdown (CHANGELOG.md), HTML Widget, JSON API, and RSS Feed | | 🖥️ Interactive Visual Studio | Live browser UI on localhost:4200 to preview, edit, and simulate in-app popups | | 🔗 Issue & PR Linking | Automatically identifies and links #12, GH-45, and commit short hashes | | 👥 Contributor Attribution | Recognizes and lists all commit authors for each release |

🚀 Quick Start

1. Launch the Visual Studio in your Browser

Run inside any Git repository:

npx @damisile_ayoola/releasenote-studio --ui

Open http://localhost:4200 to inspect commits, customize themes, test the live in-app widget simulator, and copy notes with 1 click.

2. CLI Usage (Generate directly to terminal or file)

# Generate Markdown changelog for the latest commits:
npx @damisile_ayoola/releasenote-studio

# Generate release notes between two Git tags:
npx @damisile_ayoola/releasenote-studio --from v1.0.0 --to v1.1.0

# Save output directly to CHANGELOG.md:
npx @damisile_ayoola/releasenote-studio --from v1.0.0 --output CHANGELOG.md

# Export as an In-App SaaS Widget HTML snippet:
npx @damisile_ayoola/releasenote-studio --format widget --output widget.html

🛠️ CLI Flags & Options

| Flag | Description | Default | |------|-------------|---------| | -f, --from <tag> | Starting Git tag or commit (exclusive) | Repository start | | -t, --to <tag> | Ending Git tag or commit (inclusive) | HEAD | | -v, --release-version <semver> | Release version string | v1.0.0 | | --title <title> | Custom release title | Release <version> | | --format <format> | markdown, widget, json, rss | markdown | | -o, --output <file> | Save output directly to a file | stdout | | --ui | Launch the interactive Web Studio UI | false | | -p, --port <number> | Port for the Web Studio UI | 4200 |

🖥️ Visual Studio Interface (localhost:4200)

The built-in Web Studio lets you:

• Filter Commit Ranges: Select starting and ending tags from a dropdown.
• Tweak Details: Add a release title (e.g. The Biometrics & Instant Settlement Update).
• Style In-App Widgets: Toggle Dark / Light theme and select your brand accent color.
• Simulate SaaS Modals: Test opening the modal, reading executive summaries, and checking category breakdowns.
• Copy in 1-Click: Instant clipboard buttons for Markdown, HTML Embed Code, JSON, and RSS.

🧪 Running Automated Tests

npm test

Runs the full 6-step integration suite verifying conventional parsing, breaking change detection, humanization logic, and server endpoints.

📜 License

MIT © Ayoola Damisile