setup-changelog

Scaffolds Keep-a-Changelog versioning, SemVer bump scripts, and release CI gates into projects.

Updated Mar 4, 2026
One-click install
npx skills add https://github.com/gmolike/Claude-Template --skill setup-changelog-gmolike
Or copy as Structured Prompt for Agentβ–Ό
Please help me install this Agent Skill.
Skill: setup-changelog
Source: https://github.com/gmolike/Claude-Template/tree/main/.claude/skills/setup-changelog
Command: npx skills add https://github.com/gmolike/Claude-Template --skill setup-changelog-gmolike

SYSTEM DOCUMENTATION & REQUIREMENTS

πŸ’‘ This Skill includes assets (resource) components.

What problem does it solve? Projects often lack a consistent changelog, reliable version bumps, or a defined release policy β€” the bump gets forgotten on hand-commits, tags diverge from package.json, and nobody knows which merge triggers a release. This Skill installs a standardized Keep-a-Changelog + SemVer setup with a fail-loud CI gate and a configurable branch/merge/release policy. ## Core Features & Use Cases - Two mutually exclusive mechanisms: Mechanism A (hand-written CHANGELOG.md plus a dependency-free version-bump.mjs script and a fail-loud CI guard) as the default, or Mechanism B (Changesets) for monorepos with per-package versioning β€” the bump script refuses to run when both coexist. - Ready-to-wire scaffolding assets: CHANGELOG template with compare-footer links, commitlint config enforcing Conventional Commits, a changelog-guard GitHub Actions workflow, and a SemVer bump script that derives major/minor/patch from commit history. - Configurable release policy: Default trunk-based model (squash to main, deliberate human tagging) or opt-in Gitflow with prerelease channels, documented in the project's CLAUDE.md. - Use Case: A team whose releases constantly drift out of sync invokes the Skill to install the changelog template, wire the pre-commit bump hook and CI gate, and verify the gate actually fails when code ships without an [Unreleased] entry. ## Quick Start Ask the agent to set up changelog, versioning, and release automation in this repository using the setup-changelog skill.

Frequently Asked Questions about setup-changelog

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

FAQPage Schema
How do I set up automatic SemVer version bumps from commits?β–Ό

Use the version-bump.mjs script, which reads Conventional Commits since the last v* tag and derives the level: feat gives minor, fix or perf gives patch, and a breaking-change marker gives major. It updates package.json, moves [Unreleased] into a dated release section, and maintains compare-footer links.

Changesets vs hand-written changelog with a CI gate β€” which should I use?β–Ό

Use the hand-written CHANGELOG.md plus fail-loud CI gate for single-package or small repos, since it needs no extra dependencies. Choose Changesets when a monorepo publishes multiple packages with independent versions. The two mechanisms exclude each other and must never run in the same repo.

Does the version bump work with pnpm or yarn projects?β–Ό

Yes. Mechanism A is package-manager neutral, using only node and npx with no dependencies. Mechanism B (Changesets) works equally with npm, pnpm, or yarn via pnpm changeset or yarn changeset.

Why does my git hook version bump land in the next commit?β–Ό

Git snapshots the commit tree before prepare-commit-msg, so a git add during commit-msg leaks into the following commit. Run the bump only in a pre-commit hook or in CI, never in commit-msg, to keep the bump on the same commit as the code.

What are the limitations of the changelog CI gate?β–Ό

The gate only proves that [Unreleased] was touched when code changed β€” a single whitespace line satisfies it. It catches completely forgotten changelogs but not lazy or wrong entries, so it is a tripwire rather than proof of changelog quality.