changelog

Generates and updates CHANGELOG.md files from GitHub Issues, git tags, and commit history.

Updated Nov 29, 2025

Search Tags:#automation #git #changelog #documentation #github #release notes

Ready to run

npx skills add https://github.com/peinan/dotfiles --skill changelog-peinan

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/peinan/dotfiles/tree/main/src/.claude/skills/changelog
Command: npx skills add https://github.com/peinan/dotfiles --skill changelog-peinan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of CHANGELOG.md files, ensuring that release notes are consistently generated based on GitHub Issues, git tags, and commit history in the Keep a Changelog format.

Core Features & Use Cases

Automated Changelog Generation: Creates or updates CHANGELOG.md using structured data from your repository.
Version Release Support: Streamlines the process of documenting changes for new version releases.
Use Case: When preparing to release version 1.2.0 of your software, use this Skill to automatically compile all features, bug fixes, and other changes made since the last release into a well-formatted changelog entry.

Quick Start

Use the changelog skill to create or update the changelog for version 1.2.0.

Frequently Asked Questions about changelog

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

FAQPage Schema

How do I generate release notes from git history and GitHub issues?▼

Generate release notes by compiling git commit history, git tags, and GitHub Issues into a structured CHANGELOG.md file. The tool categorizes changes based on commit prefixes and issue labels to ensure consistent release documentation.

Can I automatically create a CHANGELOG.md in Keep a Changelog format?▼

Yes, you can automatically create or update a CHANGELOG.md file in Keep a Changelog format. The automation categorizes repository changes by parsing structured data from git tags and GitHub Issues.

Do I need the GitHub CLI installed to generate a changelog?▼

Yes, the GitHub CLI (`gh`) is required to generate a changelog. The tool depends on the GitHub CLI to retrieve repository owner and name information needed to fetch issues and categorize release notes.

How do I compile release notes for multiple software versions at once?▼

Compile release notes for multiple software versions by passing multiple version arguments to the changelog generation process. The tool handles each version argument to document grouped changes sequentially in the CHANGELOG.md file.

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

The best way to categorize git commits in release notes is by using commit message prefixes and GitHub issue labels. This automated approach structures changes into appropriate categories within the Keep a Changelog format.

Does this automated changelog generation work without GitHub issue labels?▼

Changelog generation primarily relies on git commit history and tags, but it categorizes changes based on GitHub issue labels and commit prefixes. Without labels, the categorization accuracy of release notes may be reduced.