changelog

Generates categorized Markdown changelog entries from Git commit messages for pull requests.

14.0k|2.4k|Updated Dec 27, 2023
One-click install
npx skills add https://github.com/pipecat-ai/pipecat --skill changelog-pipecat-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/pipecat-ai/pipecat/tree/main/.claude/skills/changelog
Command: npx skills add https://github.com/pipecat-ai/pipecat --skill changelog-pipecat-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation of changelog entries for pull requests by summarizing relevant commits and organizing them into standardized markdown files.

Core Features & Use Cases

  • PR-level changelogs: Generates changelog entries in the changelog/ folder based on PR number and commit messages.
  • Conventional formats: Uses conventional file names like {PR_NUMBER}.added.md, {PR_NUMBER}.changed.md, {PR_NUMBER}.fixed.md, and similar.
  • Use Case: When preparing a PR, run this skill to automatically produce categorized changelog entries that describe new features, fixes, and changes.

Quick Start

Provide the PR number as an argument to generate changelog files in the changelog/ directory (e.g., 3519 to create 3519.added.md, 3519.changed.md, and 3519.fixed.md).

Frequently Asked Questions about changelog

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

FAQPage Schema
How do I automatically generate changelog entries from git commits in a PR?

This skill analyzes commits on your feature branch compared to main and automatically creates categorized markdown files in the changelog/ directory. It reads commit messages to organize changes into conventional files like {PR_NUMBER}.added.md, {PR_NUMBER}.fixed.md, and {PR_NUMBER}.changed.md based on the type of change detected.

What commit message conventions does the changelog skill use?

The skill parses conventional commit messages to categorize changes into standard changelog file types: added for new features, fixed for bug fixes, and changed for modifications. It generates predictable, machine-friendly markdown entries organized by PR number and change type in the changelog/ directory.

Can I use this skill with my existing git workflow and PR process?

Yes, the skill integrates with standard Git workflows by comparing your feature branch to main and generating changelog files as part of your PR preparation. Simply provide the PR number as an argument, and it creates the appropriate markdown files in your changelog/ directory automatically.

How does the skill organize multiple changes within a single PR?

The skill creates separate markdown files for each change type within your PR—one file for additions, one for fixes, one for modifications, and so on. Each file is named using the PR number and change category (e.g., 3519.added.md, 3519.fixed.md), keeping your changelog entries organized and predictable.

What file format does the skill use for changelog entries?

The skill writes changelog entries as markdown files stored in the changelog/ directory, using conventional naming with PR number and change type. This format is both human-readable and machine-friendly, making it easy to parse and aggregate entries when building release notes.