update-changelog

Generate CHANGES.md entries from GitHub milestone issues and PRs.

58.3k|3.9k|Updated Dec 29, 2015
One-click install
npx skills add https://github.com/penpot/penpot --skill update-changelog-penpot
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-changelog
Source: https://github.com/penpot/penpot/tree/main/.opencode/skills/update-changelog
Command: npx skills add https://github.com/penpot/penpot --skill update-changelog-penpot

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually compiling a release changelog from milestone issues and PRs is error-prone and time-consuming; this skill automates the consolidation and accurate formatting.

Core Features & Use Cases

  • Generate CHANGES.md entries by pulling issues and PRs from a specified GitHub milestone.
  • Apply correct categorization based on issue type and ensure each entry links to the user-facing issue and the fix PRs.
  • Support workflow scenarios like pre-release preparation, incremental milestone updates, and reuse across multiple releases.

Quick Start

Provide a GitHub milestone identifier and run the update to populate CHANGES.md with merged issues and PRs, correctly categorized and linked.

Frequently Asked Questions about update-changelog

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

FAQPage Schema
How do I automatically generate release notes from a GitHub milestone?

Automatically generate release notes by pulling issues and PRs from a specified GitHub milestone and inserting formatted entries into CHANGES.md. The skill applies issue_type-based categorization and links each entry to the user-facing issue and its closing PRs.

What's the best way to compile a CHANGES.md changelog without manual errors?

Compiling a CHANGES.md changelog automatically from milestone issues and PRs prevents manual formatting errors. This approach consolidates merged items, applies labeling rules, and ensures precise linking to produce accurate release notes.

Do I need Python and gh CLI to generate changelog entries from GitHub milestones?

Yes, generating changelog entries requires Python 3.8+, authenticated gh CLI, and the helper script tools/gh.py. These prerequisites fetch the milestone data and format the entries for insertion into the changelog.

How does issue type categorization work when generating release notes?

Issue type categorization works by applying labeling rules to group milestone issues and PRs automatically. The generated release notes categorize each entry based on its issue_type and provide precise links to the user-facing issue and the fix PRs.

Can I use this automated changelog workflow for incremental milestone updates across multiple releases?

Yes, you can use this workflow for incremental milestone updates and reuse it across multiple releases. It supports pre-release preparation scenarios by dynamically pulling the latest merged issues and PRs from the specified GitHub milestone.