Release Notes from Commits

Generate user-visible release notes from git commits between product tags.

Updated Dec 31, 2025
One-click install
npx skills add https://github.com/dataroaring/skills --skill release-notes-from-commits
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Release Notes from Commits
Source: https://github.com/dataroaring/skills/tree/main/skills/release-notes-from-commits
Command: npx skills add https://github.com/dataroaring/skills --skill release-notes-from-commits

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you create accurate, customer-facing release notes from the actual commits between product tags, so changelogs reflect what users will notice instead of internal implementation details or upstream summaries.

Core Features & Use Cases

  • Commit-based release notes: Summarizes user-facing changes directly from git history between tags.
  • Impact-focused filtering: Separates features, improvements, and bug fixes that matter to end users from internal plumbing, tests, and chores.
  • Version documentation workflow: Supports documenting missing releases, checking release dates, identifying upstream base versions, and cross-checking against vendor notes for completeness.
  • Use case: Generate notes for a new VeloDB Core or Apache Doris based release so product docs clearly explain what changed, who is affected, and whether the change is visible in the product.

Quick Start

Ask the skill to generate release notes for the commits between two tags and include only user-visible changes grouped into New Features, Improvements, and Bug Fixes.

Frequently Asked Questions about Release Notes from Commits

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

FAQPage Schema
How do I generate release notes from git commits between tags?

Generating release notes from git commits requires analyzing the commit range between two product tags and filtering for user-visible impact. This process groups changes into New Features, Improvements, and Bug Fixes to produce customer-facing changelogs for database and data-platform releases.

How does impact-focused filtering work for changelog generation?

Impact-focused filtering for changelog generation separates user-facing changes like features and fixes from internal plumbing, tests, and chores. This ensures release notes state the affected operation and condition, reflecting what users notice instead of internal implementation details.

Can I use git commits to document missing releases for Apache Doris or VeloDB Core?

Yes, you can use git commits to document missing releases for Apache Doris or VeloDB Core. The workflow supports checking release dates, identifying upstream base versions, and cross-checking against vendor notes to ensure product docs clearly explain what changed.

What is the best way to turn internal git history into customer-facing release notes?

The best way to turn internal git history into customer-facing release notes is by applying commit-range analysis and tag comparison. This filters out internal implementation details and produces customer-impact wording that states the affected operation and condition.

Does commit-based release notes generation work for data-platform releases?

Commit-based release notes generation works specifically for database and data-platform releases that need accurate changelogs. It requires tag comparison and filters commits to ensure changelogs accurately reflect new versions, fixes, and improvements for end users.