changelog-generator

Convert Git commit history into structured customer-friendly release notes.

4|Updated Apr 25, 2024
One-click install
npx skills add https://github.com/BridgingIT-GmbH/bITdevKit.Examples.GettingStarted --skill changelog-generator-bridgingit-gmbh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog-generator
Source: https://github.com/BridgingIT-GmbH/bITdevKit.Examples.GettingStarted/tree/main/.opencode/skills/changelog-generator
Command: npx skills add https://github.com/BridgingIT-GmbH/bITdevKit.Examples.GettingStarted --skill changelog-generator-bridgingit-gmbh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automatically converts raw git commit history into customer-facing release notes, eliminating hours of manual drafting.

Core Features & Use Cases

  • Scans Git history to identify changes across versions and time ranges.
  • Categorizes changes into logical sections such as New Features, Improvements, Bug Fixes, and Breaking Changes.
  • Translates technical commit messages into user-friendly language suitable for customers and stakeholders.
  • Formats entries into clean, structured release notes and supports styling templates (e.g., templates/CHANGELOG_STYLE.md).
  • Filters noise by excluding internal commits (refactoring, test-only commits, etc.) when appropriate.
  • Useful for generating release notes for new versions, weekly/monthly updates, and public changelogs.

Quick Start

From the root of your git repository, run the skill to generate a changelog for the latest release or a specified date range. Example commands:

  • Generate a release notes for the latest version.
  • Create a changelog for commits between 2024-01-01 and 2024-01-31 using your changelog style from templates/CHANGELOG_STYLE.md.

Frequently Asked Questions about changelog-generator

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

FAQPage Schema
How do I generate customer-friendly release notes from git commit history?

Generate customer-friendly release notes from git commit history by parsing commit messages, categorizing changes into sections like New Features and Bug Fixes, and translating technical updates into user-friendly language automatically.

Can I use a custom template to format my changelog?

Yes, you can format your changelog using a custom template by defining your preferred styling in a file named templates/CHANGELOG_STYLE.md within your repository.

How do I create a changelog for a specific date range or sprint?

Create a changelog for a specific date range by running the skill with your desired start and end dates, such as 2024-01-01 to 2024-01-31, to scan and compile only the commits within that period.

Does the changelog generator filter out internal refactoring commits?

Yes, the changelog generator filters noise by excluding internal commits such as refactoring and test-only updates, ensuring the final release notes remain relevant to customers and stakeholders.

What is the best way to automate release notes for new software versions?

Automate release notes for new versions by applying a skill that scans git history, categorizes changes logically, and formats the output into publishable, structured changelogs without manual drafting.