Changelog

What it does

This skill automates the generation of detailed changelogs for software projects using @semantic-release/changelog. It leverages commit messages formatted according to conventional commits and prepends generated notes to a CHANGELOG.md file, ensuring clear communication about project modifications. The process is triggered automatically on pushes to the main branch by a release workflow.

When to use it

• To automatically generate changelogs for software projects following a defined commit message convention.
• When you want to streamline the update process and provide users with a clear record of changes.
• For teams using conventional commits and seeking an automated way to maintain a CHANGELOG.md file.
• To easily view recent releases and their associated notes on GitHub.

Key capabilities

• Automated Changelog Generation: Automatically creates changelog entries based on commit types.
• Conventional Commits Support: Relies on conventional commits for determining changelog section headings.
• Section Mapping: Maps specific commit types (feat, fix, perf, revert, and breaking changes) to corresponding sections in the changelog (Features, Bug Fixes, Performance Improvements, Reverts, BREAKING CHANGES).
• GitHub Integration: Allows viewing of GitHub release notes and recent releases.

Example prompts

• "Show me the current changelog."
• "List the last 10 releases with their dates."
• "What are the breaking changes in the latest version?"

Tips & gotchas

• Conventional Commits Required: This skill relies on commit messages adhering to the conventional commits format. Consider using the conventional-commits skill for formatting guidance.
• Main Branch Only: Changelog generation only occurs when commits are pushed to the main branch.
• Commit Type Filtering: Commit types like chore, docs, refactor, test, and ci will not appear in the changelog.