changelog

Generate structured changelog entries from commit messages into CHANGELOG.md.

1|Updated Oct 12, 2022

Search Tags:#automation #changelog #markdown #release-notes #CHANGELOG.md #commitizen

Ready to run

npx skills add https://github.com/plastikaweb/plastikspace --skill changelog-plastikaweb

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/plastikaweb/plastikspace/tree/main/.agent/skills/changelog
Command: npx skills add https://github.com/plastikaweb/plastikspace --skill changelog-plastikaweb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of consistent, well-formatted release notes by converting commit messages and workflow events into standardized changelog entries.

Core Features & Use Cases

Conventional Changelog Mapping: maps commit types to standard sections (Added, Changed, Fixed, Removed) in CHANGELOG.md.
Unreleased Drafts & Release Entries: maintains an Unreleased section and can generate dated entries for releases.
Workflow Integration: integrates with feature branches and PRs to prepare release notes for deployment.

Quick Start

Use the changelog skill to add a new release entry for the current feature branch under the Unreleased section of CHANGELOG.md.

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 from commit messages?▼

You can auto-generate a changelog from commit messages by mapping conventional commit types to standardized sections like Added, Changed, Fixed, and Removed in your CHANGELOG.md file. This enforces consistent release notes without manual formatting.

What is the best way to maintain an Unreleased section in CHANGELOG.md?▼

Maintaining an Unreleased section in CHANGELOG.md is best handled by automating entry creation from workflow events and feature branch commits. This continuously drafts structured release notes before final deployment.

How do I structure release notes using conventional changelog practices?▼

Structuring release notes with conventional changelog practices involves categorizing commit messages into specific sections such as Added, Changed, Fixed, and Removed. This standardizes your changelog entries for better readability.

Can I generate dated release entries in CHANGELOG.md from feature branches?▼

Yes, you can generate dated release entries in CHANGELOG.md by integrating with feature branches and pull requests. This workflow prepares and structures release notes directly for deployment.

Does the changelog skill require commitizen to format markdown release notes?▼

No, the changelog skill does not strictly require commitizen to format markdown release notes. It independently enforces conventional changelog practices to write structured entries into CHANGELOG.md.