What problem does it solve?
Manually creating and maintaining changelogs and release notes is a tedious, error-prone process that often delays releases and leads to inconsistent documentation. This Skill automates the entire changelog workflow, ensuring accurate, consistent, and user-friendly release documentation with minimal effort.
Core Features & Use Cases
- Automated Entry Creation: Easily add
breaking, feature, bugfix, and change entries with required metadata like authors and PRs.
- Release Notes Generation: Preview and generate comprehensive release notes from unreleased entries without modifying source files.
- Multi-Project Support: Coordinate and unify changelogs across multiple repositories for a holistic view of changes in complex projects.
- Use Case: You've completed a new feature and need to document it for the next release. Instead of manually updating a
CHANGELOG.md file, you can use this Skill to add a structured feature entry, including authors and PRs, and then generate a preview of the upcoming release notes, saving significant time and ensuring accuracy.
Quick Start
Use the changelog-management skill to add a new 'feature' entry with the title "Add user authentication module" and link it to PR #789.