release-notes

Generate user-focused release notes from merged GitHub PRs.

1.1k|184|Updated Jan 27, 2025
One-click install
npx skills add https://github.com/i-am-bee/agentstack --skill release-notes-i-am-bee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/i-am-bee/agentstack/tree/main/.claude/skills/release-notes
Command: npx skills add https://github.com/i-am-bee/agentstack --skill release-notes-i-am-bee

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh, and includes scripts (resource) components.

What problem does it solve?

This skill helps teams generate release notes focused on users for a given Agent Stack version, turning technical changes into a concise, readable summary.

Core Features & Use Cases

  • Publish-ready notes: Generate notes ready for GitHub releases and Slack announcements.
  • Scope-aware: Identify scope by comparing the latest stable version with the target release to surface relevant user-facing changes.
  • Use Case: Imagine preparing release notes for release-v0.5.0; the skill outputs a narrative suitable for product documentation, release pages, and team communications.

Quick Start

Provide the target release tag, e.g., release-v0.5.0. The skill will determine scope from the latest stable version and output ready-to-publish notes.

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-centric release notes from merged GitHub PRs?

Generate user-centric release notes by comparing the latest stable version tag with a target release tag to enumerate merged PRs and surface user-visible changes. This produces a concise, publish-ready narrative for GitHub and Slack.

How does PR-summarization work for Slack release announcements?

PR-summarization for Slack works by fetching merged PRs between the latest stable version and a target release tag using a GitHub CLI script. It transforms technical changes into a concise, readable summary suitable for team communications.

Do I need the GitHub CLI to automate release notes for a specific version?

Yes, you need the GitHub CLI (gh) installed to automate release notes. The skill relies on a gh-based script to fetch merged PRs between version tags and determine the scope of user-facing changes.

Can I automate versioning release notes by comparing two Git tags?

Yes, you can automate versioning release notes by comparing two Git tags. The skill uses the install.sh LATEST_STABLE_AGENTSTACK_VERSION as the start point and a target release tag as the end point to scope the release.

What is the best way to create publish-ready release notes for product documentation?

The best way to create publish-ready release notes is to provide a target release tag, which allows the skill to automatically determine scope from the latest stable version and output a narrative suitable for product documentation and release pages.

What are the limitations of using GitHub CLI for release notes scope determination?

A limitation of using GitHub CLI for release notes scope determination is that it requires a valid start point from install.sh LATEST_STABLE_AGENTSTACK_VERSION and a target release tag to accurately fetch and summarize merged PRs.