changelog-collect

Collect PR information between ant-design versions and generate changelog drafts.

99.3k|54.7k|Updated Apr 24, 2015
One-click install
npx skills add https://github.com/ant-design/ant-design --skill changelog-collect
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog-collect
Source: https://github.com/ant-design/ant-design/tree/main/.agents/skills/changelog-collect
Command: npx skills add https://github.com/ant-design/ant-design --skill changelog-collect

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually compiling changelogs between ant-design releases is time-consuming and error-prone, requiring developers to sift through dozens of PRs, extract bilingual descriptions, and enforce strict formatting rules. This Skill automates the entire workflow from PR discovery to validated changelog file updates.

Core Features & Use Cases

  • Automated PR Collection: Uses gh CLI and git log to fetch all PRs between two tags or branches in parallel batches via subagents.
  • Bilingual Description Generation: Extracts or auto-generates English and Chinese changelog entries following antd's strict emoji, verb, and component naming conventions.
  • Compliance Validation: Runs npm run lint:changelog after writing to enforce formatting rules, with interactive preview before any file modification.
  • Use Case: When preparing the next minor release (e.g., 6.3.1 → 6.4.0), trigger this Skill to collect all merged PRs, filter out internal chores and tests, group entries by component, and write the final changelog to both CHANGELOG.zh-CN.md and CHANGELOG.en-US.md.

Quick Start

Collect the changelog between version 6.3.1 and master, then update both CHANGELOG.zh-CN.md and CHANGELOG.en-US.md.

Frequently Asked Questions about changelog-collect

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

FAQPage Schema
How do I generate a changelog between two ant-design versions?

Use git log to list commits between tags, extract PR numbers, then run gh pr view for each PR to retrieve titles and bodies. Parse bilingual descriptions from PR bodies or auto-generate them following antd's emoji and verb conventions, then write to CHANGELOG.zh-CN.md and CHANGELOG.en-US.md.

What tool extracts PR information from GitHub repositories?

The GitHub CLI (gh) provides gh pr view with --json flags to fetch PR title, body, author, and number. Combined with git log for commit history, it enables automated changelog generation without manual repository browsing.

Does the changelog skill support bilingual Chinese and English entries?

Yes, the skill extracts or generates both English and Chinese descriptions for every changelog entry. It writes them to separate files (CHANGELOG.en-US.md and CHANGELOG.zh-CN.md) and validates spacing rules between Chinese characters and Latin text.

Why are some PRs excluded from the antd changelog?

The skill filters out chore, test, ci, and build commits that users cannot perceive. Pure documentation tweaks and internal refactors without API changes are also skipped, unless runtime dependency upgrades bring measurable user-facing benefits.

What validation runs after writing the changelog files?

The skill executes npm run lint:changelog to verify emoji placement, component naming, spacing, and version formatting. If lint errors occur, the skill reads the error messages, corrects the offending entries, and rewrites the files until validation passes.