release-notes

Generate prose GitHub release notes from the CHANGELOG.md Unreleased section.

3|Updated Oct 28, 2020
One-click install
npx skills add https://github.com/k0d3x8its/dotfiles --skill release-notes-k0d3x8its
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/k0d3x8its/dotfiles/tree/main/claude/.claude/skills/release-notes
Command: npx skills add https://github.com/k0d3x8its/dotfiles --skill release-notes-k0d3x8its

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Turning raw changelog bullets into polished, human-readable GitHub release notes is tedious and often skipped, leaving releases undocumented or poorly communicated to users. ## Core Features & Use Cases - Changelog Parsing: Reads the ## [Unreleased] section of CHANGELOG.md and extracts everything up to the next version header. - Prose Generation: Converts bullet entries into narrative, user-focused release notes grouped thematically by impact. - Version Promotion: Optionally renames [Unreleased] to a versioned entry with the current date and resets a fresh Unreleased section for the next cycle. - Use Case: Before tagging v1.2.0, run the skill to produce ready-to-paste GitHub release prose written to RELEASE-NOTES.md, then promote the changelog in one step. ## Quick Start Ask the AI to generate release notes from the Unreleased section of CHANGELOG.md for version v1.2.0.

Frequently Asked Questions about release-notes

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

FAQPage Schema
How do I generate GitHub release notes from a changelog?▼

Point the skill at your CHANGELOG.md and it extracts the Unreleased section, then rewrites the bullets as grouped prose paragraphs suitable for a GitHub draft release. The output is printed as rendered markdown and saved to RELEASE-NOTES.md.

How to convert changelog bullets into prose release notes?▼

The skill groups changelog entries thematically rather than by order, then writes narrative paragraphs focused on user impact instead of implementation details. It avoids raw commit messages and internal variable names.

What happens if the Unreleased section is empty or missing?▼

The skill stops and informs the user without fabricating any notes. It checks for CHANGELOG.md existence and a non-empty Unreleased section before generating anything.

Can I promote Unreleased to a versioned changelog entry automatically?▼

Yes. After generating notes, the skill asks whether to promote Unreleased. If confirmed, it renames the section to the version tag with the current date and prepends a fresh empty Unreleased section above it.

Why is RELEASE-NOTES.md not committed to the repository?▼

RELEASE-NOTES.md is listed in .gitignore as ephemeral output. It exists only as a staging file for copy-pasting into the GitHub release page and is regenerated each release cycle.