skills.rest
tariknz
tariknzCOMMUNITY
Explore all skills by this author →
GitHub

release-notes

Generate Markdown release notes from GitHub PR descriptions for a version range.

242|77|Updated Nov 3, 2024
Search Tags:#automation#documentation#markdown#github#product-management#release-notes#pr-descriptions
One-click install
npx skills add https://github.com/tariknz/irdashies --skill release-notes-tariknz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/tariknz/irdashies/tree/main/.claude/skills/release-notes
Command: npx skills add https://github.com/tariknz/irdashies --skill release-notes-tariknz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This tool automatically converts GitHub PR descriptions into clear, user-facing release notes, saving time and reducing manual drafting.

Core Features & Use Cases

  • Reads merged PRs within a version range and extracts titles, bodies, and authors to compose release notes.
  • Generates structured sections (features, improvements, bug fixes) and a changelog in Markdown.
  • Ideal for product teams releasing software to customers who need consistent, readable release communications.

Quick Start

Provide user-facing release notes for a specified version by aggregating merged PR descriptions from GitHub.

Frequently Asked Questions about release-notes

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

FAQPage Schema
How do I generate user-facing release notes from GitHub PRs?▼

To generate release notes from GitHub PRs, this Skill reads merged PR descriptions for a specified version range, extracts titles and authors, and categorizes changes into structured Markdown sections.

How do I automate release notes creation for software versions?▼

Automating release notes creation involves reading the body text of merged GitHub PRs within a target version range, categorizing features and fixes, and outputting a formatted Markdown document.

Can I extract bug fixes and features from PR descriptions into a changelog?▼

Yes, you can extract bug fixes and features from PR descriptions into a changelog. The Skill parses PR bodies to categorize changes into features, fixes, and a general changelog in Markdown.

Does this release notes generator read the full PR body or just the title?▼

This release notes generator reads the full PR body rather than just the title. It extracts the complete description text to ensure concise, customer-facing summaries capture all relevant changes.

What is the best way to format GitHub release notes for customers?▼

The best way to format GitHub release notes for customers is using Markdown. This Skill outputs a structured Markdown document with dedicated sections for features, improvements, bug fixes, and a changelog.

Do I need GitHub PRs to be merged before drafting release notes?▼

Yes, GitHub PRs need to be merged before drafting release notes. The Skill aggregates descriptions from merged PRs within a specified version range to compose the final user-facing documentation.

Related Skills

Explore More Content & Communication Skills→
entoreneeentorenee
4

changelog-generation

Generate stakeholder-friendly changelogs from merged pull requests.

Community
Intermediate
frostantfrostant
42

changelog-generator

Converts git commit history into categorized, ready-to-publish markdown release notes.

Community
Intermediate
CoooolfanCoooolfan
380

github-release

Automate GitHub release creation and format release notes via browser workflow.

Community
Basic
MichaelSolatiMichaelSolati

changelog

Generate categorized internal and player-facing changelogs from git history and sprint reports.

Community
Advanced