update-changelog

Aggregate unreleased Git commits into the CHANGELOG.md Unreleased section.

6|1|Updated Nov 23, 2023

Search Tags:#automation #git #changelog #versioning #documentation #markdown #release

Ready to run

npx skills add https://github.com/gmcabrita/dotfiles --skill update-changelog-gmcabrita

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-changelog
Source: https://github.com/gmcabrita/dotfiles/tree/main/.agents/skills/update-changelog
Command: npx skills add https://github.com/gmcabrita/dotfiles --skill update-changelog-gmcabrita

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps repository changelogs up to date by aggregating unreleased changes from Git history and applying them to CHANGELOG.md (or CHANGELOG) in a consistent format.

Core Features & Use Cases

Scans commits since the latest baseline tag to capture new changes.
Updates the Unreleased section of CHANGELOG.md (or CHANGELOG) with human-friendly entries.
Creates a changelog when none exists and preserves existing formatting and structure.

Quick Start

Run the skill to refresh the changelog with the most recent unreleased changes.

Frequently Asked Questions about update-changelog

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

FAQPage Schema

How do I automatically update a changelog from git history?▼

Yes, it can create a changelog if none exists. When no CHANGELOG.md or baseline tag is found, the skill uses a fallback mechanism to generate a new markdown file populated with human-friendly entries derived from your recent git commits.

How does the changelog update process find unreleased commits?▼

The changelog update process finds unreleased commits by using git describe to identify the latest baseline release tag, then running git log to capture all changes between that tag and the current main branch that are not yet incorporated into the changelog.

Will updating the changelog overwrite my existing markdown formatting?▼

No, updating the changelog preserves your existing markdown formatting and structure. The skill reads the current CHANGELOG.md and modifies only the Unreleased section, ensuring your historical release notes remain completely intact.

Do I need a specific versioning tag format to generate changelog entries?▼

You need at least one baseline release tag for the skill to accurately calculate unreleased changes. If no baseline tag exists, the skill supports a fallback mode to aggregate changes, but established versioning tags yield the most accurate results.

What is the best way to maintain repository documentation for unreleased changes?▼

The best way to maintain repository documentation for unreleased changes is to aggregate git commits between the last release tag and main branch. This skill automates that process, updating the Unreleased section of your changelog with consistent entries.