skills.rest
medusajs
medusajsOFFICIAL
Explore all skills by this author →
Website𝕏@medusajsGitHub

writing-releases

Generates GitHub release notes for Medusa releases from commit and PR metadata.

36.1k|5.2k|Updated Jan 18, 2020
Search Tags:#release notes#Markdown#Documentation#Versioning#gitHub#medusa#ChangeLog
One-click install
npx skills add https://github.com/medusajs/medusa --skill writing-releases
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-releases
Source: https://github.com/medusajs/medusa/tree/main/.claude/skills/writing-releases
Command: npx skills add https://github.com/medusajs/medusa --skill writing-releases

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Writing consistent, well-formatted GitHub release notes from raw commit and PR data is tedious and error-prone, especially when enforcing strict formatting rules around highlights, breaking changes, and changelog links.

Core Features & Use Cases

  • Structured Release Notes: Produces release notes in the established Medusa style with strict section ordering (Highlights, Features, Bugs, Documentation, Chores, Other Changes, New Contributors, Full Changelog).
  • Release Type Classification: Distinguishes minimal patch releases, single-highlight releases, multi-highlight releases, and releases with breaking changes based on changesets and PR labels.
  • Breaking Change Handling: Embeds breaking changes inside Highlight subsections with a 🚧 marker, migration code blocks, and nuance blockquotes instead of a separate top-level section.
  • Use Case: Given a list of commits and PR metadata for a new Medusa version, generate a complete draft release description with correctly formatted bullets, author links, PR links, and the mandatory Full Changelog compare link.

Quick Start

Ask the assistant to write release notes for the new Medusa version using the provided list of commits and PR metadata.

Frequently Asked Questions about writing-releases

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

FAQPage Schema
How do I write GitHub release notes from a list of commits?▼

Provide the commit list and PR metadata, and the skill classifies the release type, groups entries by conventional commit prefix into Features, Bugs, and other sections, and formats each bullet with author and PR links in the Medusa style.

How are breaking changes handled in Medusa release notes?▼

Breaking changes are detected via minor changesets in .changeset/ or a breaking-change PR label. They must appear as Highlight subsections starting with a 🚧 Breaking change line, including migration steps in a fenced code block, never in a separate top-level section.

When should a release include a Highlights section?▼

Include Highlights only for significant changes such as new modules, wide API surfaces, new architecture patterns, or major commerce capabilities. Routine fixes, small features, and dependency upgrades go in the standard bullet sections only.

What is the required format for release note bullets?▼

Each bullet uses an asterisk with three spaces, the conventional commit prefix with scope, a description, the author as a linked GitHub handle, and the PR as a linked number, for example feat(cart): add gift cards by [@user](url) in [#123](url).

Why must the Full Changelog link always appear at the end?▼

The Full Changelog compare link is a mandatory final line in the Medusa release format, written in bold as a non-heading line linking the previous tag to the new tag via the GitHub compare URL.

Related Skills

Explore More Software Engineering Skills→
kangnam7654kangnam7654
1

release-changelog

Generate a changelog file from git history, changesets, and PR metadata.

Community
Advanced
paperclipaipaperclipai
79.8k

release-changelog-discord-message

Generate formatted Discord release announcements from Paperclip changelog files.

Official
Advanced
reaatechreaatech
2

Changelog Generation

Generate CHANGELOG.md entries and version bumps from conventional commits using Changesets.

Community
Advanced
patternflypatternfly
10

pf-component-structure

Audits and enforces proper structural nesting in PatternFly React components.

Official
Intermediate