update-changelog

Updates repository changelogs with notable commits since the last git tag.

Updated Feb 22, 2024
One-click install
npx skills add https://github.com/tlipoca9/dotfiles --skill update-changelog-tlipoca9
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-changelog
Source: https://github.com/tlipoca9/dotfiles/tree/main/home/dot_agents/skills/update-changelog
Command: npx skills add https://github.com/tlipoca9/dotfiles --skill update-changelog-tlipoca9

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping a changelog current requires manually reviewing every commit since the last release, judging which changes matter to users, and formatting entries consistently. This Skill automates that review by gathering commits from git history and drafting properly styled changelog entries. ## Core Features & Use Cases - Baseline Detection: Automatically finds the most recent git tag with git describe --tags --abbrev=0 when no baseline version is provided. - Commit Review: Collects all commits between the baseline and HEAD, filtering out insignificant changes like typo fixes and internal refactoring. - Style-Preserving Updates: Appends entries to the existing "Unreleased" section while matching the changelog's headings, bullet style, and ordering; supports both CHANGELOG.md and CHANGELOG files. - Use Case: Before cutting a release, run this Skill to populate the Unreleased section with user-facing features, fixes, and breaking changes ordered by importance, including pull request references. ## Quick Start Update the changelog with all notable changes since the last release tag.

Frequently Asked Questions about update-changelog

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

FAQPage Schema
How do I update a changelog from git commits?▼

Find the baseline with `git describe --tags --abbrev=0`, then list commits with `git log <baseline>..HEAD`. Add notable user-facing changes to the Unreleased section of CHANGELOG.md, ordered by breaking changes, features, then fixes.

What changes should be included in a changelog?▼

Include notable user-facing changes: features, fixes, and breaking changes, referencing pull request numbers when available. Ignore typo fixes, internal refactoring, dependency bumps, and minor documentation updates.

Does this work if my changelog file is named CHANGELOG instead of CHANGELOG.md?▼

Yes. The Skill reads CHANGELOG.md first and falls back to CHANGELOG if the markdown file does not exist, preserving whichever style and formatting the existing file uses.

What if my changelog has no Unreleased section?▼

The Skill adds an Unreleased section at the top of the file, matching the existing heading style, for example `## Unreleased` versus `## [Unreleased]`. If one already exists with content, new entries are appended rather than replacing it.

Can I specify a baseline version instead of the latest git tag?▼

Yes. Provide a baseline version explicitly and the Skill uses it instead of auto-detecting the most recent tag. It also respects non-main default branch names as the current version.