skills.rest
miethe
mietheCOMMUNITY
Explore all skills by this author →
Website𝕏@MietheGitHub

changelog-sync

Audit CHANGELOG coverage for user-facing commits in a git range.

Updated May 3, 2026
Search Tags:#changelog#ci#git commits#json reporting#coverage validation#release audit
One-click install
npx skills add https://github.com/miethe/boxbrain-2 --skill changelog-sync
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: changelog-sync
Source: https://github.com/miethe/boxbrain-2/tree/main/.claude/skills/changelog-sync
Command: npx skills add https://github.com/miethe/boxbrain-2 --skill changelog-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill identifies user-facing commits that are missing from the CHANGELOG Unreleased section, helping prevent incomplete release notes without modifying repository files.

Core Features & Use Cases

  • Coverage Auditing: Compares commits across a specified git range with entries in the CHANGELOG Unreleased section.
  • Commit Classification: Distinguishes reportable commits from exempt prefixes such as documentation, testing, and maintenance changes.
  • Structured Reporting: Produces human-readable coverage tables or machine-readable JSON, with exit codes suitable for release gates and CI.
  • Use Case: Run it before a version bump to detect changelog gaps that must be remediated by a human before releasing.

Quick Start

Use the changelog-sync skill to audit CHANGELOG coverage from the previous release tag through the current repository head and report any gaps.

Frequently Asked Questions about changelog-sync

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

FAQPage Schema
How do I check changelog coverage before a release?▼

Changelog coverage auditing compares user-facing git commits in a specified range against your CHANGELOG Unreleased section to identify missing entries before a version bump.

Can I use changelog auditing as a CI gate?▼

Yes, changelog auditing provides blocking exit codes and JSON reporting, making it suitable for automated CI gates and pre-release checks without modifying repository files.

How do I prevent internal commits from failing my changelog audit?▼

Changelog auditing distinguishes reportable commits from exempt prefixes like documentation, testing, and maintenance, excluding configured non-reportable commit types from coverage validation.

What is needed to audit unreleased changelog entries?▼

Auditing unreleased changelog entries requires Git history access and a CHANGELOG.md file to compare commits against the Unreleased section and report gaps.

How does JSON reporting work for release audits?▼

JSON reporting for release audits outputs machine-readable results identifying missing user-facing commits, allowing automated parsing of changelog coverage gaps alongside blocking exit codes.

Does changelog auditing modify repository files during validation?▼

No, changelog auditing validates coverage without modifying files, ensuring safe ad hoc verification and pre-release checks that only report gaps for human remediation.

Related Skills

Explore More Software Engineering Skills→
jubscodesjubscodes
49

gspdev-changelog

Update CHANGELOG.md from git history following Keep a Changelog format.

Community
Intermediate
danielterradanielterra
19

release-create

Bump versions, update changelogs, and publish GitHub releases.

Community
Advanced
charlesjones-devcharlesjones-dev
34

preflight-checks

Run type checks, linting, formatting, and tests across multiple project types.

Community
Intermediate
edfentonedfenton
3

shared-changelog

Generate CHANGELOG.md from Git history using conventional commits.

Community
Advanced