create-draft-release-notes

Creates organized GitHub draft release notes grouped by conventional commit type.

12.9k|843|Updated Apr 1, 2022
One-click install
npx skills add https://github.com/web-infra-dev/rspack --skill create-draft-release-notes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-draft-release-notes
Source: https://github.com/web-infra-dev/rspack/tree/main/.agents/skills/create-draft-release-notes
Command: npx skills add https://github.com/web-infra-dev/rspack --skill create-draft-release-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Manually organizing GitHub-generated release notes into clean, categorized changelogs is tedious and error-prone, especially when verifying release PRs and staged npm packages before publishing a draft release.

Core Features & Use Cases

  • Draft Release Creation: Creates a GitHub draft release with generated notes via the gh CLI, then organizes the body by conventional commit type (breaking changes, features, performance, fixes, and more).
  • Release Safety Checks: Verifies that the release PR is merged and that staged npm packages are live before creating the draft, preventing premature releases.
  • Markdown Fallback: When gh lacks permissions, outputs the organized Markdown directly with manual creation steps.
  • Use Case: A maintainer releasing v2.0.6 of an npm package asks the assistant to create the draft release; the Skill checks the merged release PR, confirms staged packages are published, generates notes from the previous tag, and saves a categorized draft.

Quick Start

Ask the assistant to create organized draft release notes for tag v2.0.6 in your GitHub repository.

Frequently Asked Questions about create-draft-release-notes

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

FAQPage Schema
How do I create a GitHub draft release with organized notes?

Provide a release tag like v2.0.6 and the target repository. The workflow uses the gh CLI to generate notes from the previous tag, then runs a Node.js script that groups items by conventional commit type and saves the organized body back to the draft.

How are release notes categorized by commit type?

Items are classified by their conventional commit prefix: feat maps to New Features, fix to Bug Fixes, perf to Performance, refactor to Refactor, docs to Document, and types with an exclamation mark to Breaking Changes. Everything else falls under Other Changes.

What happens if gh CLI lacks permission to create the draft?

The workflow falls back to generating notes through the GitHub API when read access exists, then returns the organized Markdown in the conversation with manual steps to create the draft at the repository's releases page.

Does it check npm staged publishing before creating a release?

Yes, when the repository uses npm staged publishing, it inspects the latest merged release PR for changed package.json files and verifies each public package version is live on npm. If any are missing, it stops and lists the packages awaiting approval.

Can I organize existing release notes Markdown without creating a release?

Yes, run the script directly with a Markdown file path or pipe content via stdin. It reorganizes the What's Changed section into categorized sections while preserving all original item text, authors, and links.