skills.rest
webdevcody
webdevcodyCOMMUNITY
Explore all skills by this author →
Website𝕏@webdevcodyGitHub

update-changelog

Append a newest-first emoji bullet to CHANGELOG.md from a git diff.

22|3|Updated Jul 28, 2024
Search Tags:#automation#changelog#documentation#release notes#change management#git diff#commit workflow
One-click install
npx skills add https://github.com/webdevcody/go-mailing-list --skill update-changelog-webdevcody
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-changelog
Source: https://github.com/webdevcody/go-mailing-list/tree/main/.claude/skills/update-changelog
Command: npx skills add https://github.com/webdevcody/go-mailing-list --skill update-changelog-webdevcody

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you keep a consistent, user-focused CHANGELOG.md by adding a fresh entry at the right moment, without cluttering the log with noise like formatting-only or test-only changes.

Core Features & Use Cases

  • Correct, chronological updates: Appends a newest-first bullet that reflects the actual behavior change, not just touched files.
  • Category-emoji, user-perspective wording: Uses a single allowed category emoji and keeps the sentence concise and understandable to a user who will read release notes later.
  • When to log vs. skip: Avoids entries for generated-file churn, dependency lockfile bumps, doc typos, formatting/lint-only diffs, and other non-user-visible work.

Quick Start

Ask the AI to run the update-changelog skill to append an accurate, newest-first emoji bullet to the repo root CHANGELOG.md based on the current staged diff (or the latest commit if nothing is staged), and to skip if the changes are not changelog-worthy.

Frequently Asked Questions about update-changelog

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

FAQPage Schema
How do I automatically generate changelog entries from git diff?▼

You can automatically generate changelog entries from git diff by reading staged changes or the latest commit to append a newest-first, user-focused emoji bullet to CHANGELOG.md reflecting the actual behavior change.

What is the best way to keep release notes focused on user-visible changes?▼

Keeping release notes focused on user-visible changes requires skipping formatting-only diffs, test-only changes, lockfile bumps, and doc typos, while logging exclusively engineering-significant feature completions, bug fixes, and security patches.

How do I format a CHANGELOG.md entry for a new feature or bug fix?▼

Formatting a CHANGELOG.md entry involves appending a concise, user-perspective bullet prefixed with a single allowed category emoji that reflects the actual behavior change, ordered newest-first.

When should I not add an entry to my changelog workflow?▼

You should not add an entry to your changelog workflow for generated-file churn, dependency lockfile bumps, doc typos, formatting or lint-only diffs, and other trivial internal changes that lack user-visible impact.

Can I trigger changelog updates just before making a git commit?▼

Yes, you can trigger changelog updates just before a commit or by using explicit changelog trigger phrases, which prompts the skill to read the current staged diff and append the relevant entry.

Related Skills

Explore More Software Engineering Skills→
IntegralistIntegralist
2

changelog

Generate Keep a Changelog entries from Git commit diffs.

Community
Intermediate
sk8metalmesk8metalme
1

changelog

Generate Keep a Changelog documents from Conventional Commit history.

Community
Advanced
douglasdennys45douglasdennys45

changelog-automation

Generate project changelogs from Conventional Commits and Semantic Versioning.

Community
Advanced
ArabelaTsoArabelaTso
142

change-log-generator

Generate Markdown changelogs from git commit history with conventional commits.

Community
Intermediate