release-notes

Summarize merged GitHub PRs between two releases into categorized Markdown notes.

3|7|Updated Nov 7, 2025
One-click install
npx skills add https://github.com/dimagi/dimagi-claude-workflows --skill release-notes-dimagi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/dimagi/dimagi-claude-workflows/tree/main/plugins/connect-tech/skills/release-notes
Command: npx skills add https://github.com/dimagi/dimagi-claude-workflows --skill release-notes-dimagi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates human-readable release notes by scanning the two most recent GitHub releases of a repository, collecting merged PRs between them, and producing a grouped Markdown document.

Core Features & Use Cases

  • Identify releases: Retrieves the latest and previous releases from GitHub.
  • Aggregate PRs: Collects merged PRs between the two releases and reads titles and bodies for context.
  • Classify changes: Categorizes changes as New, Improvement, Fix, Infra, or Docs.
  • Generate output: Produces a clean Markdown release notes file saved to the outputs folder, ready for sharing.

Quick Start

Provide a GitHub repo URL or owner/repo and run the skill to generate the release notes for the two latest releases.

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 merged PRs between two GitHub releases?

To generate release notes from merged PRs, the skill identifies the latest two GitHub releases for a repository, aggregates the merged PRs between them, classifies changes by category, and outputs a grouped Markdown file.

Can I generate release notes for a private GitHub repository?

Yes, you can generate release notes for a private GitHub repository by providing the repository URL or owner/repo format and ensuring you have gh CLI access configured for authentication.

How are merged pull requests categorized in the generated changelog?

Merged pull requests in the generated changelog are categorized into five groups: New, Improvement, Fix, Infra, and Docs. The skill reads PR titles and bodies to classify each change accordingly.

What's the best way to automate changelog generation for GitHub repositories?

Automating changelog generation for GitHub repositories is best done by passing a repository URL or owner/repo identifier to the skill, which then fetches release data and PR details via gh CLI to produce a Markdown summary.

Do I need gh CLI installed to aggregate PRs and generate release notes?

Yes, you need gh CLI installed and authenticated to fetch release data and PR details from both public and private GitHub repositories for the release notes generation process.

What format is the release notes output saved in?

The release notes output is saved as a grouped Markdown file in the outputs folder, categorizing all merged PRs between the two latest releases into New, Improvement, Fix, Infra, or Docs sections ready for sharing.