skills.rest
sgcarstrends
sgcarstrendsOFFICIAL
Explore all skills by this author →
GitHub

changelog

Generate CHANGELOG.md from conventional commits using semantic-release.

21|2|Updated Nov 5, 2023
Search Tags:#git#changelog#semantic-release#release-notes#conventional-commits
One-click install
npx skills add https://github.com/sgcarstrends/sgcarstrends --skill changelog-sgcarstrends
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/sgcarstrends/sgcarstrends/tree/main/.claude/skills/changelog
Command: npx skills add https://github.com/sgcarstrends/sgcarstrends --skill changelog-sgcarstrends

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps generate and maintain a CHANGELOG.md using semantic-release and conventional commits to keep release notes accurate and up-to-date.

Core Features & Use Cases

  • Automatic changelog generation: Create changelogs from conventional commits.
  • Versioning integration: Align changelog entries with semantic versioning.
  • Release notes automation: Publish notes with GitHub releases.

Quick Start

To generate a changelog for the upcoming release, run semantic-release to extract notes from commits and update CHANGELOG.md.

Frequently Asked Questions about changelog

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

FAQPage Schema
How do I automate changelog generation from git commits?▼

Automate changelog generation by using semantic-release with conventional commits to extract version-relevant changes from your git history. Semantic-release parses commit messages, determines version bumps, generates changelog entries, and updates CHANGELOG.md automatically during release workflows.

What's the best way to maintain release notes aligned with semantic versioning?▼

Enforce conventional commits in your repository and integrate semantic-release into CI to align changelog entries with semantic versions. This approach automatically categorizes changes—Added, Changed, Deprecated, Fixed, Security—and highlights breaking changes, keeping release notes synchronized with version numbers.

Can I publish release notes to GitHub automatically?▼

Yes. Semantic-release integrates with GitHub to publish generated release notes alongside each tagged release. The changelog data flows directly from conventional commits into GitHub releases, eliminating manual documentation steps in your CI workflow.

Do I need conventional commits to generate changelogs?▼

Conventional commits are the standard input format for semantic-release changelog generation. They provide structured commit metadata—type, scope, breaking changes—that semantic-release parses to extract meaningful changelog entries and determine version increments.

How does Keep a Changelog formatting work with semantic-release?▼

Semantic-release formats changelog output following Keep a Changelog conventions with standard sections: Added, Changed, Deprecated, Fixed, and Security. This standardized structure makes changelogs readable and maintainable across releases while keeping breaking changes prominently visible.

Related Skills

Explore More Software Engineering Skills→
mcj-codermcj-coder
1

branching-strategy-and-conventions

Configure Git branching strategies, Conventional Commits, and merge rules.

Community
Advanced
patricio0312revpatricio0312rev
5

release-automation-builder

Automate npm package release workflows with changesets or semantic-release.

Community
Advanced
ccfccf

changelog-automation

Generate CHANGELOG.md from commits, PRs, and releases using Keep a Changelog.

Community
Advanced
nmdranmdra
26

keep-a-changelog

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

Community
Intermediate