release-notes

Generate release notes from base_version, target_version, release_report, and commit_log.

Updated Feb 7, 2026
One-click install
npx skills add https://github.com/lorrandavid/.dotfiles --skill release-notes-lorrandavid
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/lorrandavid/.dotfiles/tree/main/.config/.copilot/skills/release-notes
Command: npx skills add https://github.com/lorrandavid/.dotfiles --skill release-notes-lorrandavid

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Generating accurate and consumable release notes from a structured release diff, commit history, and predefined templates to save time and ensure consistency across internal and external documentation.

Core Features & Use Cases

  • Generates a Release Title and the main sections (Summary, Whats New, Improvements & Refactors, Breaking Changes, Operational Notes, Known Risks & Watchouts, Commits Included) from base_version, target_version, release_report, and commit_log.
  • Applies a templated structure from references/templates.md to maintain consistent formatting and wording for different audiences.
  • Supports both internal review and public-facing documentation, with optional migration steps and rollback guidance.

Quick Start

Generate release notes for the upcoming release using base_version, target_version, release_report, and commit_log.

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 commit history automatically?

To generate release notes from commit history, you provide the base version, target version, release report, and commit log. The skill processes this structured diff data to output standardized documentation with sections like Summary, What's New, and Breaking Changes.

What is the best way to structure release notes for both internal and external audiences?

The best way to structure release notes for different audiences is to apply a predefined template. This skill enforces a defined output structure with sections like Summary, Improvements & Refactors, Operational Notes, and Known Risks to maintain consistent formatting across internal and public documentation.

Can I use a commit log to create release documentation with breaking changes and rollback guidance?

Yes, you can use a commit log and release diff to create documentation that includes breaking changes and rollback guidance. The skill processes your commit history to produce comprehensive release notes with optional migration steps for your target version.

Does this release notes tool require a specific format for the release diff and commit log inputs?

This release notes generator requires structured inputs including base_version, target_version, release_report, and commit_log. It processes these specific data points against templated structures to produce consistent documentation without needing external dependencies.

What sections are included when generating release notes from a structured release diff?

Generating release notes from a structured release diff includes sections for Summary, What's New, Improvements & Refactors, Breaking Changes, Operational Notes, Known Risks, and a summarized Commits Included list derived from your commit history.