changelog

Generate changelogs from git history and audit documentation against the codebase.

Updated Mar 6, 2026
One-click install
npx skills add https://github.com/BeargleIndustries/beargle-plugins --skill changelog-beargleindustries
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/BeargleIndustries/beargle-plugins/tree/main/plugins/changelog/skills/changelog
Command: npx skills add https://github.com/BeargleIndustries/beargle-plugins --skill changelog-beargleindustries

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the generation of changelogs and audits documentation against the codebase to ensure consistency, preventing issues like outdated instructions or non-existent commands.

Core Features & Use Cases

  • Changelog Generation: Creates changelogs from git history, tailored for different audiences.
  • Documentation Auditing: Compares documentation against the actual code to find discrepancies.
  • Automated Fixing: Attempts to auto-fix unambiguous inconsistencies found during the audit.
  • Use Case: Ensure your project's README accurately reflects the latest installation steps and API usage by running a documentation audit before each release.

Quick Start

Run the changelog skill to generate a markdown report for the current repository.

Frequently Asked Questions about changelog

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

FAQPage Schema
How do I generate changelogs from git history for a software release?

To generate changelogs from git history, the Skill analyzes repository commits and compiles them into tailored release notes for different audiences. It outputs detailed reports in Markdown or JSON formats.

How do I audit documentation against my codebase for inconsistencies?

Documentation auditing compares your project's README against the actual codebase to find outdated instructions, non-existent commands, or API usage errors. It flags these discrepancies and attempts to auto-fix unambiguous inconsistencies.

Can I auto-fix documentation drift found during a code audit?

Yes, you can auto-fix documentation drift because the code audit attempts to automatically correct unambiguous inconsistencies found during the documentation review. It addresses issues in installation, API usage, configuration, and architecture.

Do I need any dependencies to run a documentation audit for release notes?

No dependencies are required to run a documentation audit for release notes. The Skill operates independently without external dependencies to generate changelogs and check documentation consistency against your codebase.

What is the best way to keep project README files consistent with code changes?

The best way to keep README files consistent with code changes is to run a documentation audit before each release. This compares documentation against the actual codebase to catch drift and auto-fix unambiguous discrepancies.

What formats are supported for exporting git changelog and audit reports?

Markdown and JSON formats are supported for exporting git changelog and audit reports. The Skill provides detailed consistency reports in these formats to help document installation steps, API usage, configuration, and architecture.