changelog-generator

Generate user-facing release notes from git commits with categorized changes.

1|1|Updated Jun 4, 2024
One-click install
npx skills add https://github.com/dhar174/tiny_village --skill changelog-generator-dhar174
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog-generator
Source: https://github.com/dhar174/tiny_village/tree/main/.codex/changelog-generator
Command: npx skills add https://github.com/dhar174/tiny_village --skill changelog-generator-dhar174

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generates user-facing release notes from git commits by analyzing history and translating technical changes into clear customer-facing language, saving hours of manual work.

Core Features & Use Cases

  • Scans git history to identify commits relevant to releases.
  • Categorizes changes into features, improvements, fixes, and breaking changes.
  • Formats professional release notes suitable for public documentation and internal product updates.
  • Supports customization guidelines and branding to align with your style.

Quick Start

Run the generator in your repository to create a release notes draft from the current commits.

Frequently Asked Questions about changelog-generator

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

FAQPage Schema
How do I generate release notes from git history automatically?

To generate release notes from git history, this Skill scans your repository commits and categorizes them into features, improvements, fixes, and breaking changes. It translates technical commit logs into clear, customer-facing documentation in minutes.

Can I customize the branding and formatting of my public changelogs?

Yes, you can customize branding and formatting for public changelogs by applying your own guidelines and templates. This ensures the generated release notes align with your specific style and brand identity.

Does the changelog generator group breaking changes separately from regular fixes?

Yes, the changelog generator groups breaking changes separately from regular fixes. It analyzes git commits and categorizes all changes into distinct groups: features, improvements, fixes, and breaking changes.

What is the best way to create consistent weekly or monthly release summaries?

The best way to create consistent weekly or monthly release summaries is to run the generator in your repository. It produces brand-aligned documentation by automatically drafting release notes from your current commits.

Do I need any specific dependencies to turn git commits into customer-facing language?

No specific dependencies are required to turn git commits into customer-facing language. The Skill operates independently to analyze your repository history and translate technical changes into clear release notes.