home / skills / jst-well-dan / skill-box / changelog-generator

changelog-generator skill

/no-code-builder/changelog-generator

This skill automatically generates user-friendly changelogs from git commits, turning technical history into clear, publish-ready release notes.

This is most likely a fork of the changelog-generator skill from questnova502
npx playbooks add skill jst-well-dan/skill-box --skill changelog-generator

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
3.0 KB
---
name: changelog-generator
description: Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.
author: mhattingpete
---

# Changelog Generator

This skill transforms technical git commits into polished, user-friendly changelogs that your customers and users will actually understand and appreciate.

## When to Use This Skill

- Preparing release notes for a new version
- Creating weekly or monthly product update summaries
- Documenting changes for customers
- Writing changelog entries for app store submissions
- Generating update notifications
- Creating internal release documentation
- Maintaining a public changelog/product updates page

## What This Skill Does

1. **Scans Git History**: Analyzes commits from a specific time period or between versions
2. **Categorizes Changes**: Groups commits into logical categories (features, improvements, bug fixes, breaking changes, security)
3. **Translates Technical → User-Friendly**: Converts developer commits into customer language
4. **Formats Professionally**: Creates clean, structured changelog entries
5. **Filters Noise**: Excludes internal commits (refactoring, tests, etc.)
6. **Follows Best Practices**: Applies changelog guidelines and your brand voice

## How to Use

### Basic Usage

From your project repository:

```
Create a changelog from commits since last release
```

```
Generate changelog for all commits from the past week
```

```
Create release notes for version 2.5.0
```

### With Specific Date Range

```
Create a changelog for all commits between March 1 and March 15
```

### With Custom Guidelines

```
Create a changelog for commits since v2.4.0, using my changelog 
guidelines from CHANGELOG_STYLE.md
```

## Example

**User**: "Create a changelog for commits from the past 7 days"

**Output**:
```markdown
# Updates - Week of March 10, 2024

## ✨ New Features

- **Team Workspaces**: Create separate workspaces for different 
  projects. Invite team members and keep everything organized.

- **Keyboard Shortcuts**: Press ? to see all available shortcuts. 
  Navigate faster without touching your mouse.

## 🔧 Improvements

- **Faster Sync**: Files now sync 2x faster across devices
- **Better Search**: Search now includes file contents, not just titles

## 🐛 Fixes

- Fixed issue where large images wouldn't upload
- Resolved timezone confusion in scheduled posts
- Corrected notification badge count
```

**Inspired by:** Manik Aggarwal's use case from Lenny's Newsletter

## Tips

- Run from your git repository root
- Specify date ranges for focused changelogs
- Use your CHANGELOG_STYLE.md for consistent formatting
- Review and adjust the generated changelog before publishing
- Save output directly to CHANGELOG.md

## Related Use Cases

- Creating GitHub release notes
- Writing app store update descriptions
- Generating email updates for users
- Creating social media announcement posts

Overview

This skill automatically converts git commit history into clear, user-facing changelogs and release notes. It analyzes commits, groups them into common categories, and rewrites technical messages into customer-friendly language. The output is formatted for direct publishing or quick review, saving hours of manual editing.

How this skill works

The tool scans a repository’s git history for a specified range (dates, tags, or commits) and filters out noise like test and refactor commits. It categorizes commits into features, improvements, fixes, breaking changes, and security items, then rewrites each entry into concise, non-technical copy. Finally it assembles a polished changelog with headings and consistent formatting, optionally following a provided style guide.

When to use it

  • Preparing release notes for a product or library release
  • Generating weekly or monthly product update summaries
  • Creating app store or marketplace update descriptions
  • Publishing a public changelog or product updates page
  • Producing internal release documentation for stakeholders

Best practices

  • Run the generator from your repository root to ensure complete history access
  • Specify tags or date ranges to focus the changelog on a single release window
  • Provide a CHANGELOG_STYLE file to enforce brand tone and formatting
  • Review generated entries and tweak phrasing for sensitive or complex changes
  • Exclude internal-only commits by keeping consistent commit message prefixes or using the tool’s ignore rules

Example use cases

  • Create release notes for version 2.5.0 from commits between tags
  • Generate a one-week update summary for customer email and blog post
  • Produce concise app store update text tailored to non-technical users
  • Build a public CHANGELOG.md entry from the last month’s commits
  • Generate an internal change summary for product and support teams

FAQ

Can it detect breaking changes automatically?

Yes. It identifies commits labeled as breaking changes or those referencing major API changes and highlights them in a dedicated section for attention.

How do I customize tone and formatting?

Provide a style guide file (for example CHANGELOG_STYLE.md) or select a built-in voice profile. The generator applies those rules when rewriting and formatting entries.