repomatic-changelog

Automates drafting, validating and fixing changelog entries in changelog.md using git history and style rules.

57|8|Updated Dec 9, 2021
One-click install
npx skills add https://github.com/kdeldycke/repomatic --skill repomatic-changelog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repomatic-changelog
Source: https://github.com/kdeldycke/repomatic/tree/main/.claude/skills/repomatic-changelog
Command: npx skills add https://github.com/kdeldycke/repomatic --skill repomatic-changelog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users manage their changelog.md file by drafting, validating, and fixing entries based on git history and established style rules.

Core Features & Use Cases

  • Draft Changelog Entries: Automatically review git commits and suggest new entries for the unreleased section.
  • Validate Changelog: Check the changelog.md against defined linting rules.
  • Fix Changelog Issues: Automatically correct detected issues in the changelog file.
  • Use Case: After a development cycle, use this Skill to quickly generate draft entries for new features and bug fixes, then ensure the changelog adheres to project standards before a release.

Quick Start

Use the repomatic-changelog skill to add new entries based on recent git commits.

Frequently Asked Questions about repomatic-changelog

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

FAQPage Schema
How do I automatically generate changelog entries from git commits?

You can automatically generate changelog entries by analyzing your git log history to draft new entries for the unreleased section of your changelog.md file. This process reviews recent commits to suggest features and bug fixes.

How do I validate and lint a changelog.md file before a release?

You can validate a changelog.md file by checking its contents against defined linting rules for entry content and version formatting. This ensures the changelog adheres to project standards before a software release.

Can I automatically fix formatting issues in my changelog file?

Yes, you can automatically fix detected issues in a changelog file. The tool corrects formatting and style rule violations to maintain consistent release notes without manual editing.

What is the best way to maintain consistent release notes across development cycles?

The best way to maintain consistent release notes is to automate the drafting, validation, and fixing of changelog entries using git history and established style rules. This ensures accurate documentation after each development cycle.

Do I need specific commit message formats to draft changelog entries from git history?

The changelog drafting process leverages git log historical context to suggest entries based on recent commits. Adherence to specific style rules for entry content and version formatting is required for the final changelog output.

Why are my changelog entries failing validation during the release process?

Changelog entries fail validation when they do not adhere to specific style rules for entry content and version formatting. Checking the changelog.md against defined linting rules identifies these standard violations.