home / skills / codingheader / myskills / changelog-generator

changelog-generator skill

/skills/changelog-generator

This skill automatically generates user-friendly changelogs from git commits, saving time and producing polished release notes.

This is most likely a fork of the changelog-generator skill from questnova502
npx playbooks add skill codingheader/myskills --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.
---

# 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 generates user-facing changelogs from git commit history, turning technical commit messages into clear, customer-friendly release notes. It groups changes into categories, filters noise, and formats entries to match your brand voice. Use it to save hours of manual writing and produce consistent, publishable changelogs in minutes.

How this skill works

The skill scans git history for a specified range or between versions and parses commit messages. It classifies commits into categories such as features, improvements, bug fixes, breaking changes, and security. Technical language is rewritten into plain, customer-focused descriptions, noise commits are filtered out, and the output is formatted into a structured changelog ready for publication.

When to use it

  • Preparing release notes for a new version
  • Creating weekly or monthly product update summaries
  • Writing app store or marketplace update descriptions
  • Generating public changelog entries or internal release documents
  • Producing email or social updates about product changes

Best practices

  • Run the tool from your repository root to ensure complete history access
  • Specify version tags or date ranges for targeted changelogs
  • Provide a CHANGELOG_STYLE guideline to enforce consistent tone and format
  • Review generated output before publishing to adjust voice or highlight priorities
  • Exclude internal-only commits by using conventional commit prefixes or ignore lists

Example use cases

  • Create release notes for version 2.5.0 with categorized user-friendly entries
  • Generate a weekly update from commits in the past seven days for a customer email
  • Produce app store release text that emphasizes benefits and fixed issues
  • Build a public changelog page by saving generated output directly to CHANGELOG.md
  • Create internal release documentation highlighting breaking changes and migration notes

FAQ

Can I control the wording and tone of the changelog?

Yes. Provide a style guideline or examples and the skill will apply that voice to the generated entries. You can also review and edit the output before publishing.

How does it avoid noisy commits like refactors or tests?

The skill uses heuristics and configurable ignore lists (conventional commit prefixes, keywords) to filter out internal-only commits and prioritize user-impacting changes.