keep-a-changelog

Name: keep-a-changelog
Availability: InStock
Author: NIMENDRA

Parse Git commit history and format CHANGELOG.md entries per Keep a Changelog standards.

26|1|Updated Sep 8, 2022

Search Tags:#automation #git #changelog #versioning #documentation #semver

Ready to run

npx skills add https://github.com/nmdra/Dotfiles --skill keep-a-changelog-nmdra

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: keep-a-changelog
Source: https://github.com/nmdra/Dotfiles/tree/main/.agents/skills/keep-a-changelog
Command: npx skills add https://github.com/nmdra/Dotfiles --skill keep-a-changelog-nmdra

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the manual effort and inconsistency involved in maintaining project changelogs, ensuring your documentation always reflects the latest versioning and release history.

Core Features & Use Cases

Automated Versioning: Automatically generates new version entries based on Git commit history.
Standardized Formatting: Enforces the Keep a Changelog structure and Semantic Versioning guidelines.
Use Case: When preparing for a new release, use this Skill to scan your recent commits, categorize them into Added, Changed, or Fixed sections, and prepend the formatted entry to your CHANGELOG.md file.

Quick Start

Use the keep-a-changelog skill to add a new minor version entry to the changelog based on the latest git commits.

Frequently Asked Questions about keep-a-changelog

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

FAQPage Schema

How do I automatically generate a changelog from Git commit history?▼

To automatically generate a changelog from Git commit history, you can parse commit logs and format entries into standardized sections like Added, Changed, or Fixed. This enforces Keep a Changelog and Semantic Versioning standards.

How does Semantic Versioning work with Keep a Changelog formatting?▼

Semantic Versioning assigns incrementing release numbers, while Keep a Changelog structures the release notes into standardized categories. This approach categorizes Git commits into Added, Changed, or Fixed sections to document updates accurately.

Do I need Git CLI access to automate changelog updates?▼

Yes, Git CLI access is required to automate changelog updates. The process operates on repository-level CHANGELOG.md files and relies on Git CLI to analyze commit logs and generate accurate release documentation.

What is the best way to maintain a CHANGELOG.md file for a new release?▼

The best way to maintain a CHANGELOG.md file for a new release is to scan recent Git commits, categorize them into standardized sections, and prepend the formatted entry. This eliminates manual formatting and ensures documentation reflects the latest versioning.

Can I categorize Git commits into Added, Changed, and Fixed sections automatically?▼

Yes, you can categorize Git commits into Added, Changed, and Fixed sections automatically. By parsing Git commit history, the system identifies update types and formats them according to Keep a Changelog standards without manual sorting.

What are the limitations of using Git commit history for versioning documentation?▼

A limitation of using Git commit history for versioning documentation is that the accuracy depends entirely on the quality of commit messages. Poorly written or vague commits will result in inaccurate or unhelpful changelog entries.