release-notes

Aggregate commits and PR metadata between two git tags into categorized release notes.

5.7k|578|Updated Jan 26, 2022
One-click install
npx skills add https://github.com/dlt-hub/dlt --skill release-notes-dlt-hub
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/dlt-hub/dlt/tree/main/.claude/skills/release-notes
Command: npx skills add https://github.com/dlt-hub/dlt --skill release-notes-dlt-hub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates structured release notes by analyzing commits between two git tags, extracting PR metadata, and attributing authors to each item, saving time and reducing manual errors.

Core Features & Use Cases

  • Automated tag-to-release parsing: validate tags, determine the previous tag, and collect relevant commits and PRs.
  • PR categorization and attribution: classify changes (breaking, highlights, docs, core library) and attach author details for each entry.
  • Use Case: Produce a clean, publish-ready changelog for a new software release with a clear breakdown of changes and contributors.

Quick Start

Provide a range of git tags (for example, 1.2.3 -- 1.2.2) to generate a formatted release notes document.

Frequently Asked Questions about release-notes

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

FAQPage Schema
How do I automate release notes generation from git tags?

Automate release notes by analyzing commits and pull request metadata between two git tags to produce categorized, author-attributed changelog entries. Provide a tag range like 1.2.3 -- 1.2.2 to generate a publish-ready document with a clear breakdown of changes and contributors.

How does PR categorization work for automated changelogs?

PR categorization for automated changelogs works by classifying changes into categories like breaking, highlights, docs, and core library. It extracts PR metadata and attaches author details to each entry, ensuring consistent release notes without manual sorting.

Do I need GitHub access to generate release notes from commits?

You need repository data access via gh or API to generate release notes from commits. Accessing GitHub pull request metadata is required to extract author attribution and categorize changes accurately between the specified git tags.

What's the best way to attribute authors in a git changelog?

The best way to attribute authors in a git changelog is to extract pull request metadata between tags. This automatically attaches contributor details to each categorized entry, reducing manual errors and saving time during release preparation.

Can I generate a changelog for a specific software version range?

You can generate a changelog for a specific software version range by providing two git tags. The process validates the tags, determines the previous tag, and collects relevant commits and PRs to output a structured release notes document.

Why are my git release notes missing pull request details?

Git release notes may miss pull request details if repository data is inaccessible via gh or API, or if tags are incorrect. Proper tagging and PR extraction logic are required to collect metadata and attribute authors successfully.