generate-release-notes

Generate a redis-py GitHub release-notes draft from merged PRs since the previous release tag.

13.6k|2.7k|Updated Nov 6, 2009
One-click install
npx skills add https://github.com/redis/redis-py --skill generate-release-notes-redis
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-release-notes
Source: https://github.com/redis/redis-py/tree/main/.agents/skills/generate-release-notes
Command: npx skills add https://github.com/redis/redis-py --skill generate-release-notes-redis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Drafting release notes for redis-py by hand means manually collecting every merged PR since the last tag, mapping labels to categories, and formatting sections consistently, which is slow and error-prone. This Skill automates that collection and categorization while keeping the maintainer in control of publishing. ## Core Features & Use Cases - PR collection from git history: Lists commits on a release branch since the previous tag, resolves each to its PR, and fetches title, labels, and author via read-only GitHub commands. - Label-driven categorization: Maps PR labels to the project's canonical sections (New Features, Experimental, Breaking Changes, Deprecations, Bug Fixes, Maintenance) and infers categories for unlabeled PRs using an authoritative labels guide. - Template-conformant draft output: Assembles a Markdown draft with optional Highlights, grouped related PRs, and a contributors footer, saved to release_notes/release_notes_<version>.md without committing or publishing. - Use Case: A maintainer preparing redis-py 8.0.2 asks for release notes for the 8.0 branch; the Skill collects all PRs since v8.0.1, categorizes them, and writes a ready-to-paste draft file. ## Quick Start Ask the assistant to generate release notes for the 8.0 branch of redis-py and save the draft as a Markdown file.

Frequently Asked Questions about generate-release-notes

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

FAQPage Schema
How do I generate release notes for a redis-py release?

Provide the release branch (e.g. 8.0) and the Skill collects commits since the previous v* tag, resolves each to its PR, categorizes them by label, and writes a Markdown draft to release_notes/release_notes_<version>.md for manual review and publishing.

How are PRs categorized into release notes sections?

PRs are categorized by their labels using the pr-labels-guide reference: feature/enhancement map to New Features, breakingchange to Breaking Changes, fix/bug to Bug Fixes, and so on. Unlabeled PRs get an inferred category based on their diff, title, and branch name.

Does this Skill publish the GitHub release automatically?

No. The Skill only writes a local Markdown draft file in the working tree. It never commits, tags, pushes, or creates a GitHub release; the maintainer reviews the draft and publishes it manually through the GitHub UI.

What happens to PRs labeled skip-changelog?

PRs labeled skip-changelog are excluded from the release notes entirely. Process and triage labels like triage, question, or stale are ignored for categorization and never appear in the notes.

Can a single PR appear in multiple release notes sections?

Yes. A PR carrying labels from more than one category, such as deprecation and breakingchange, is listed under every matching section. The same applies when multiple inference rules match an unlabeled change.

Why does the Skill not use automated release-drafter output?

The Skill's documentation states that automated release-drafter output misses PRs and miscategorizes them. Instead, it collects PRs directly from git history and categorizes each one manually using the authoritative label mapping references.