changelog

Generate and debug CHANGELOG.md entries from semantic-release and conventional commits.

21|2|Updated Nov 5, 2023
One-click install
npx skills add https://github.com/motormetrics/motormetrics --skill changelog-motormetrics
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/motormetrics/motormetrics/tree/main/.claude/skills/changelog
Command: npx skills add https://github.com/motormetrics/motormetrics --skill changelog-motormetrics

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Changelogs are auto-generated and kept synchronized with your release workflow, making it easy to track changes across versions and diagnose missing entries.

Core Features & Use Cases

  • Auto-generate CHANGELOG.md during releases using semantic-release and conventional commits
  • Map commit types (feat, fix, perf, revert) to structured changelog sections and ignore noise like chore/docs
  • View, debug, and maintain release notes to support release planning and auditing

Quick Start

Open CHANGELOG.md to review the latest release notes.

Frequently Asked Questions about changelog

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

FAQPage Schema
How do I auto-generate a CHANGELOG.md from conventional commits?

You can auto-generate a CHANGELOG.md by using semantic-release to parse conventional commits, mapping types like feat and fix into structured release notes while ignoring noise like chore or docs commits.

Why does my semantic-release changelog skip certain commits?

Your semantic-release changelog skips commits because it filters out non-release-relevant types like chore and docs, only mapping feat, fix, perf, and revert commits into structured changelog sections.

Do I need conventional commits to use semantic-release for release notes?

Yes, you need conventional commits to use semantic-release for release notes, as the changelog generation relies on structured commit types to determine the correct version bump and changelog entries.

What's the best way to debug missing entries in a semantic-release changelog?

To debug missing entries in a semantic-release changelog, review your commit messages to ensure they follow conventional commits formatting, then check your release configuration to confirm the commit types are mapped correctly.

Can I map specific commit types to custom changelog sections?

Yes, you can map specific commit types to custom changelog sections by configuring your semantic-release workflow to recognize conventional commit types like feat, fix, perf, and revert, while ignoring noise like chore and docs.

Does semantic-release work for maintaining release notes across multiple versions?

Yes, semantic-release works for maintaining release notes across multiple versions by automatically appending new structured entries to your CHANGELOG.md during each release, keeping historical records synchronized with your release workflow.