skills.rest
gitkraken
gitkrakenOFFICIAL
Explore all skills by this author →
Website𝕏@gitkrakenGitHub

changelog-story

Reorganizes CHANGELOG unreleased sections into structured release notes with umbrella entries.

9.9k|1.8k|Updated Aug 8, 2016
Search Tags:#release management#Git#release notes#Markdown#Documentation#ChangeLog#Editing
One-click install
npx skills add https://github.com/gitkraken/vscode-gitlens --skill changelog-story
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: changelog-story
Source: https://github.com/gitkraken/vscode-gitlens/tree/main/.claude/skills/changelog-story
Command: npx skills add https://github.com/gitkraken/vscode-gitlens --skill changelog-story

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Unreleased changelog sections accumulate entries in arrival order, becoming long, disorganized, and exhausting to read on release day. This Skill rewrites the [Unreleased] section of CHANGELOG.md into a coherent release story with pillar features as umbrella entries, tightened wording, and pruned intra-release noise.

Core Features & Use Cases

  • Umbrella Restructuring: Groups 3-5 pillar features into top-level entries with sub-bullets, ordered by user-facing value.
  • Intra-Release Pruning: Verifies fixes against the last stable git tag and cuts entries for bugs users never saw.
  • Issue Reference Preservation: Extracts every #NNNN reference before rewriting and diffs the sets afterward so no reference is silently lost.
  • Use Case: Before shipping GitLens 18.4, ask the Skill to reorganize the unreleased section — it consolidates the Commit Graph work into one umbrella entry, merges duplicate bullets, and removes fixes to features that never shipped.

Quick Start

Ask the assistant to reorganize the CHANGELOG's unreleased section into a release story and tell it which features are the pillars of this release.

Frequently Asked Questions about changelog-story

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

FAQPage Schema
How do I clean up a messy changelog before a release?▼

Use this Skill to rewrite the [Unreleased] section of CHANGELOG.md. It groups pillar features into umbrella entries with sub-bullets, orders entries by user-facing value, tightens wording, and prunes fixes that users never observed on the last stable release.

How to organize changelog entries into feature groups?▼

The Skill applies an umbrella pattern: each pillar feature becomes one top-level entry with a plain-language lede line, and related changes become sub-bullets beneath it. You specify the 3-5 pillar features, and everything else is clustered or kept standalone by value.

Does it verify fixes against the previous release tag?▼

Yes. It runs git grep and git show against the last stable tag to confirm whether a fixed bug was observable in the shipped release. Fixes to code that did not exist at the tag are pruned as intra-release changes.

Can it add missing entries to the changelog?▼

No, it only reorganizes existing entries. If a pillar feature has no entry, it flags the gap and suggests running a commit audit first. An optional gap audit can match commits since the tag against the curated section, with each finding verified independently.

What happens to issue references during the rewrite?▼

Every #NNNN reference is extracted before rewriting and diffed afterward. A dropped reference is only acceptable when its entire entry was deliberately cut, and those cuts are listed in the final report for your veto.

Related Skills

Explore More Software Engineering Skills→
mhamzahashimmhamzahashim

release-changelog

Generate a Paperclip release changelog from commits and changesets.

Community
Advanced
rodacatorodacato

ship

Bump project versions, finalize CHANGELOGs, and create GitHub releases.

Community
Advanced
nthpaulnthpaul

make-pr-easy-to-review

Clean GitHub pull request history and improve reviewer guidance.

Community
Intermediate
koralliskorallis
90

changelog-generator

Generates changelogs from Git history, commit messages, and pull requests.

Community
Basic