release-notes

Generate structured Markdown release notes from Git commits, PRs, and issues.

851|215|Updated May 29, 2025
One-click install
npx skills add https://github.com/agentic-community/mcp-gateway-registry --skill release-notes-agentic-community
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/agentic-community/mcp-gateway-registry/tree/main/.claude/skills/release-notes
Command: npx skills add https://github.com/agentic-community/mcp-gateway-registry --skill release-notes-agentic-community

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create release notes automatically for a new software version by compiling changes from commits, PRs, and issues since a chosen base release.

Core Features & Use Cases

  • Generate a structured release notes document in release-notes/v{version}.md.
  • Tag the repository with the new version and push the tag.
  • Include upgrade guidance sections and environment considerations for operators.

Quick Start

Use this skill to generate release notes for a new version.

Frequently Asked Questions about release-notes

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

FAQPage Schema
How do I generate release notes from Git commits and pull requests?

Generate release notes by aggregating commits, pull requests, and fixed issues since a chosen base release. The tool compiles these Git-based changes into a structured Markdown document and saves it to release-notes/v{version}.md.

Can I automatically tag a repository and push changes when generating a changelog?

Yes, generating a changelog automatically tags the repository with the new version and pushes the changes. This happens after the tool collects git log data and formats it into a standardized Markdown document.

Does the release notes generation process handle version format normalization?

Yes, release notes generation supports normalization of version formats. It checks for existing tags before applying the new version tag to the repository to prevent conflicts during the aggregation process.

What is the best way to include breaking changes and upgrade guidance in versioning documentation?

Include breaking changes and upgrade guidance by collecting changelog data from git logs and issues, then formatting the results into a standardized Markdown document. The output incorporates environment considerations for operators alongside the structured release notes.

How does automated release notes generation work with existing Git tags?

Automated release notes generation checks for existing tags before applying a new version tag to the repository. It aggregates commits, PRs, and issues since the base release to ensure no duplicate versioning occurs when pushing changes.