changelog-automation

Generate Keep a Changelog changelogs from commits, PRs, and releases.

1|1|Updated Dec 15, 2024
One-click install
npx skills add https://github.com/Alejocabeza/dotfiles --skill changelog-automation-alejocabeza
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog-automation
Source: https://github.com/Alejocabeza/dotfiles/tree/main/opencode/skills/changelog-automation
Command: npx skills add https://github.com/Alejocabeza/dotfiles --skill changelog-automation-alejocabeza

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the generation of a standardized changelog from commits, PRs, and releases, aligning with Keep a Changelog to streamline release notes.

Core Features & Use Cases

  • Automated generation of CHANGELOG.md from Conventional Commits and merged PR data.
  • Support for semantic versioning and release-note templates.
  • Use case: integrate into CI workflows to produce release notes automatically on each release.

Quick Start

Provide a release-ready changelog by feeding your commit history and PR data into the workflow.

Frequently Asked Questions about changelog-automation

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

FAQPage Schema
How do I automate changelog generation from conventional commits?

Automate changelog generation by parsing conventional commit history and merged PR data to produce a CHANGELOG.md aligned with the Keep a Changelog format. This workflow integrates into CI pipelines to compile release notes automatically on each release.

How does semantic versioning integrate with automated release notes?

Semantic versioning integrates with release notes by applying version bumps based on conventional commit types. The automation evaluates commit messages to determine patch, minor, or major releases, then generates corresponding release notes for the published version.

Does this changelog automation work with GitHub Actions and semantic-release?

Yes, this changelog automation implements GitHub Actions workflows and supports multiple release tooling approaches including semantic-release, standard-version, and cliff to produce and publish changelogs directly within your CI/CD pipeline.

What is the best way to format release notes for Keep a Changelog?

The best way to format release notes for Keep a Changelog is to automate generation from commits and PR data. This approach standardizes entries by mapping conventional commits directly into the structured Keep a Changelog categories.

Can I use standard-version to generate a CHANGELOG.md from merged PRs?

Yes, you can use standard-version alongside this automation to generate a CHANGELOG.md. The workflow processes merged PR data and conventional commits to produce standardized release notes compatible with standard-version outputs.

When should I not use automated changelog generation?

You should avoid automated changelog generation when your project lacks consistent conventional commit messages or merged PR data. Without structured commit history, the automation cannot accurately map changes into semantic versioning or Keep a Changelog categories.