skills.rest
tailcallhq
tailcallhqOFFICIAL
Explore all skills by this author →
Website𝕏@tailcallhqGitHub

write-release-notes

Generate structured Markdown release notes from GitHub release and PR metadata.

7.5k|1.4k|Updated Dec 8, 2024
Search Tags:#automation#changelog#summarization#markdown#github#release-notes#pr-details
One-click install
npx skills add https://github.com/tailcallhq/forgecode --skill write-release-notes-tailcallhq
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-release-notes
Source: https://github.com/tailcallhq/forgecode/tree/main/.forge/skills/write-release-notes
Command: npx skills add https://github.com/tailcallhq/forgecode --skill write-release-notes-tailcallhq

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Automatically generate accurate, user-facing release notes for a given GitHub release by pulling release metadata and all linked PR details and assembling them into a coherent narrative.

Core Features & Use Cases

  • Fetches release metadata (tag, publish date, name, body) and linked PR details from GitHub.
  • Categorizes PRs by type (features, fixes, maintenance) and crafts a narrative that highlights what changed and why it matters.
  • Produces a structured Markdown release notes document suitable for distribution and changelog maintenance, with sections such as What's New, Highlights, Bug Fixes & Reliability, and Contributors.

Quick Start

Use this skill to generate release notes for a specific version tag (e.g., v1.32.0).

Frequently Asked Questions about write-release-notes

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

FAQPage Schema
How do I automatically generate release notes from GitHub PRs?▼

Generating release notes from GitHub PRs involves pulling release metadata and linked PR details, then categorizing them into features, fixes, and maintenance to produce a structured Markdown changelog. This approach highlights concrete outcomes and user-facing benefits.

What is the best way to structure a changelog for a new GitHub release?▼

The best way to structure a changelog is to categorize PRs by type and craft a narrative with clear sections such as What's New, Highlights, Bug Fixes & Reliability, Under the Hood, and Contributors. This highlights what changed and why it matters to users.

Does generating GitHub release notes require any specific command line tools?▼

Generating GitHub release notes does require specific command line tools. You need to have the GitHub CLI and jq installed in your environment to fetch release metadata and parse linked PR details for the synthesis process.

How do I summarize GitHub PR details into user-facing release notes?▼

To summarize GitHub PR details into release notes, apply a category-based synthesis to the fetched PR data. This process transforms raw PR details into a clear narrative, organizing changes into user-facing sections like What's New and Bug Fixes.

Can I create a Markdown changelog automatically from a specific GitHub release tag?▼

Yes, you can create a Markdown changelog automatically from a specific GitHub release tag. The process fetches the metadata for the given version tag and assembles all linked PR details into a coherent narrative suitable for changelog maintenance.

Related Skills

Explore More Software Engineering Skills→
rawvegrawveg
40

github-issue-fetcher

Fetch GitHub issues from the current repository using gh and jq.

Community
Advanced
frostantfrostant
42

changelog-generator

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

Community
Intermediate
CyanAutomationCyanAutomation
1

release-publish

Automate tag-triggered Docker image and GitHub release publication.

Community
Advanced
ThomashighbaughThomashighbaugh
1

changelog-generator

Generate structured Markdown release notes from categorized git commit histories.

Community
Intermediate