release-notes

Draft release notes from merged GitHub pull requests, commits, and tags.

Updated May 6, 2026
One-click install
npx skills add https://github.com/UnionStreetAI/unionstreet --skill release-notes-unionstreetai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/UnionStreetAI/unionstreet/tree/main/plugins/github/skills/release-notes
Command: npx skills add https://github.com/UnionStreetAI/unionstreet --skill release-notes-unionstreetai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing release notes by hand means digging through merged pull requests, commit history, and tags to reconstruct what changed, which is slow and error-prone for maintainers shipping frequent releases. ## Core Features & Use Cases - History Gathering: Collects merged PRs, notable commits, authors, labels, linked issues, and breaking-change markers using gh pr list, gh release view, and git log. - Categorized Grouping: Organizes changes into user-facing categories such as added, changed, fixed, security, performance, docs, and internal. - Structured Output: Produces release notes with a headline summary, grouped changes, breaking changes or migrations, contributors, and verification or deployment notes. - Use Case: Before tagging v2.4.0, ask for release notes covering everything since v2.3.0 and receive a maintainer-ready changelog highlighting breaking changes and new environment variables. ## Quick Start Draft release notes for this repository covering all merged pull requests between the previous tag and the upcoming release.

Frequently Asked Questions about release-notes

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

FAQPage Schema
How do I generate release notes from GitHub pull requests?▼

Gather merged PRs with gh pr list, review prior releases with gh release view, and inspect commits with git log across the tag range. Then group changes into categories like added, fixed, and security, and rewrite PR titles into clear release prose.

How to write a changelog between two git tags?▼

Identify the previous tag, target tag, and branch range, then use git log to list commits in that range. Combine this with merged PR metadata to produce grouped changes, breaking changes, contributors, and deployment notes.

Does this release notes workflow require the GitHub CLI?▼

Yes, the workflow relies on the gh CLI commands gh pr list and gh release view to collect pull request and release metadata, alongside git log for commit history. The repository must be accessible through gh authentication.

What should release notes include for breaking changes?▼

Breaking changes should be called out separately from grouped changes, including migrations, configuration changes, and new environment variables. Known risks and verification or deployment notes should also be highlighted when available.

What are the limitations of PR-based release notes?▼

PR-based notes depend on the quality of PR titles, descriptions, and labels, so vague or missing metadata produces weaker summaries. Changes merged without pull requests must be captured from commit messages via git log instead.