changelog

Parse conventional commits and update CHANGELOG.md with categorized markdown entries.

13.1k|2.2k|Updated Mar 22, 2024
One-click install
npx skills add https://github.com/BasedHardware/omi --skill changelog-basedhardware
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/BasedHardware/omi/tree/main/.cursor/skills/changelog
Command: npx skills add https://github.com/BasedHardware/omi --skill changelog-basedhardware

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation of release changelog entries by parsing git commits and pull requests, organizing changes, and updating CHANGELOG.md, saving time during releases and release notes preparation.

Core Features & Use Cases

  • Parse commits using the conventional commits format to extract type, scope, description, breaking changes, and issue references.
  • Categorize changes into Features, Bug Fixes, Documentation, Refactoring, Performance, Tests, Chores, and Breaking Changes for clear release notes.
  • Generate and format changelog entries in standard markdown and update CHANGELOG.md at the top of the file.
  • Use on releases, PR merges, or when a user requests a changelog.

Quick Start

Run the changelog generator in your repository to produce a new entry and update CHANGELOG.md. Example: run the /auto-changelog command in CI or locally, then review and commit the updated file.

Frequently Asked Questions about changelog

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

FAQPage Schema
How do I auto-generate release notes from git commits?

You can auto-generate release notes by parsing git commits using the conventional commits format. The tool extracts commit types and descriptions, categorizes them into features and bug fixes, then formats and inserts the entries into CHANGELOG.md.

How does conventional commit parsing work for changelog generation?

Conventional commit parsing for changelog generation extracts the type, scope, description, breaking changes, and issue references from your commit messages. It then groups these parsed elements into categorized markdown sections for your release notes.

How do I update CHANGELOG.md automatically when merging pull requests?

To update CHANGELOG.md automatically during PR merges, run the changelog generator in your repository. It parses the merged pull requests and commits, formats the changes into standard markdown, and inserts the new release entry at the top of the file.

Can I categorize git commits into features and bug fixes for release notes?

Yes, you can categorize git commits into Features, Bug Fixes, Documentation, Refactoring, Performance, Tests, Chores, and Breaking Changes. This categorization relies on parsing conventional commit messages to organize release notes clearly.

Do I need conventional commits to generate a changelog?

Yes, conventional commits are required to automatically parse type, scope, and breaking changes. This structured commit format allows the changelog generator to accurately categorize changes and format them into standard markdown entries.

What is the best way to prepare release notes for software deployments?

The best way to prepare release notes is to run the changelog generator on-demand during releases. It parses recent commits and pull requests, categorizes the changes, and updates CHANGELOG.md with formatted markdown entries.