changelog

Generate structured CHANGELOG.md files from git commit history.

3|Updated Jul 4, 2020
One-click install
npx skills add https://github.com/mei28/dotfiles --skill changelog-mei28
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/mei28/dotfiles/tree/main/.claude/skills/changelog
Command: npx skills add https://github.com/mei28/dotfiles --skill changelog-mei28

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually writing and maintaining release notes is time-consuming and error-prone; this skill automatically generates CHANGELOG.md from git history following Keep a Changelog and semantic versioning.

Core Features & Use Cases

  • Automated categorization of commits into Added, Changed, Fixed, Deprecated, Removed, and Security.
  • Maintains an Unreleased section and versioned entries with proper links to commits.
  • Supports semantic versioning and provides a ready-to-publish changelog for software releases.

Quick Start

Run the changelog generator to create or update CHANGELOG.md from your Git history.

Frequently Asked Questions about changelog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a CHANGELOG.md from git history automatically?

To generate a CHANGELOG.md from git history, this skill parses commit messages using conventional commits and formats them into categorized sections. It applies semantic versioning to maintain an Unreleased section alongside versioned entries with links to commits.

What is the best way to categorize git commits for release notes?

Categorizing git commits for release notes is done by parsing conventional commit messages and sorting them into Added, Changed, Fixed, Deprecated, Removed, and Security sections. This approach follows the Keep a Changelog standard to ensure structured documentation.

Can I use semantic versioning to maintain an Unreleased section in my changelog?

Yes, you can use semantic versioning to maintain an Unreleased section in your changelog. The generator automatically groups parsed commits under an Unreleased header until they are assigned a specific semantic version tag during a software release.

Does this changelog generator work for software projects of all sizes?

This changelog generator works for software projects of all sizes that require automated and consistent release notes. As long as the project uses git history with conventional commit messages, it can parse and format the entries effectively.

What are the limitations of generating release notes from commit history?

Generating release notes from commit history relies entirely on parsing conventional commit messages; if commits lack proper prefixes, they may not categorize correctly. Manual writing is bypassed, but inconsistent commit formatting limits the accuracy of the categorized CHANGELOG.md sections.