Changelog Generator

Generate Markdown and plain-text changelogs from git commits.

34|11|Updated Jan 19, 2025
One-click install
npx skills add https://github.com/QuilibriumNetwork/quorum-desktop --skill changelog-generator-quilibriumnetwork
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Changelog Generator
Source: https://github.com/QuilibriumNetwork/quorum-desktop/tree/main/.claude/skills/changelog-generator
Command: npx skills add https://github.com/QuilibriumNetwork/quorum-desktop --skill changelog-generator-quilibriumnetwork

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, bash.

What problem does it solve?

This skill automates the creation of professional changelogs from Git history, saving time and reducing manual effort during releases.

Core Features & Use Cases

  • Analyze commits in a repository to identify changes across categories (New Features, Enhancements, Bug Fixes, Localization, Maintenance, and Compatibility).
  • Generate both technical (developer-friendly) and user-friendly changelog outputs in multiple formats (Markdown, plain text).
  • Create structured release notes with links to commits and a summary of the release.

Quick Start

Use the changelog generator to produce a technical changelog for the last 7 days:

  • Command: ./changelog-generator.sh 7 cross-platform false
  • Command (user-friendly): ./changelog-user-friendly.sh 14 cross-platform true
  • Review the generated files in skill/changelogs and share with stakeholders.

Frequently Asked Questions about Changelog Generator

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

FAQPage Schema
How do I auto-generate a changelog from git commits?

You can auto-generate a changelog from git commits by running a bash script that filters repository history, maps commits to categories like Bug Fixes and New Features, and outputs structured Markdown or plain text release notes.

What's the best way to create user-friendly release notes from conventional commits?

Creating user-friendly release notes from conventional commits involves mapping technical commit messages into categorized summaries, producing both developer-friendly technical logs and non-technical Markdown reports for stakeholders.

Can I generate a changelog for a specific number of days using bash?

Yes, you can generate a changelog for a specific timeframe by passing the desired number of days as an argument to the bash script, which filters the git history accordingly to produce the release report.

Do I need any specific environment setup to automate changelog generation from git history?

You need a runtime environment with git and bash installed to automate changelog generation from git history, along with defined template sets and filters to correctly categorize and format the output.

How does a changelog generator map git commits to categories like Enhancements and Maintenance?

A changelog generator maps git commits to categories like Enhancements and Maintenance by applying predefined filters to the commit history, analyzing the messages to classify changes, and grouping them into structured outputs.

What formats are supported when auto-generating release notes from a repository?

Auto-generating release notes from a repository supports multiple output formats including Markdown and plain text, allowing you to produce both technical developer-friendly logs and user-friendly summaries with commit links.