changelog

Generate CHANGELOG.md from Git history with Keep a Changelog format.

2|Updated Oct 1, 2024
One-click install
npx skills add https://github.com/ZeiZel/dotfiles --skill changelog-zeizel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/ZeiZel/dotfiles/tree/main/.claude/skills/changelog
Command: npx skills add https://github.com/ZeiZel/dotfiles --skill changelog-zeizel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generates and updates CHANGELOG.md by deriving entries from Git history and aligning with the Keep a Changelog standard.

Core Features & Use Cases

  • Analyzes commits since the last release to populate unreleased sections.
  • Categorizes changes into Added, Changed, Deprecated, Removed, Fixed, and Security.
  • Generates properly formatted release notes with links to pull requests and issues.

Quick Start

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

Frequently Asked Questions about changelog

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

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

You can generate a CHANGELOG.md by parsing Git commit messages to detect conventional prefixes, categorizing changes into standard sections, and outputting formatted release notes with linked PR references.

How do I keep a changelog in sync with unreleased Git commits?

To keep a changelog in sync, analyze commits since the last release to populate the unreleased section, categorizing entries into Added, Changed, Deprecated, Removed, Fixed, and Security categories.

Can I automatically categorize Git commits into Keep a Changelog sections?

Yes, Git commits are automatically categorized into Keep a Changelog sections by detecting conventional commit prefixes and mapping them to the appropriate change categories.

How do I add pull request links to generated release notes?

Generated release notes include pull request links by parsing Git history and automatically inserting properly formatted PR references into the CHANGELOG.md entries.

Does this changelog generator work without any external dependencies?

Yes, this changelog generator operates without external dependencies, directly analyzing Git history and applying the Keep a Chelog format to produce the output file.

What is the best way to maintain a Keep a Changelog format using Git history?

The best way to maintain a Keep a Changelog format is to automatically derive entries from Git history, aligning commit messages with standard categories and versioned releases.