release-notes
Generate release notes from change lists, PR summaries, or commit messages. Use when the user asks for release notes/发布说明/变更记录.
When & Why to Use This Skill
This Claude skill automates the creation of professional release notes by synthesizing technical data from change lists, pull request summaries, and commit messages. It streamlines the software documentation process, ensuring that user-visible impacts and breaking changes are clearly communicated in a structured, user-friendly format, significantly reducing manual effort for developers and product managers.
Use Cases
- Automated Changelog Generation: Quickly transform a list of merged pull requests into a structured 'Added, Fixed, Changed' release document for new software versions.
- Stakeholder Communication: Summarize complex technical commit histories into concise, high-level updates suitable for non-technical stakeholders and customers.
- Breaking Change Documentation: Automatically identify and highlight critical API changes or breaking updates from technical logs to ensure user awareness and smooth transitions.
- Version History Management: Maintain a consistent and professional version history by formatting raw developer notes into standardized templates including dates and version numbers.
| name | release-notes |
|---|---|
| description | Generate release notes from change lists, PR summaries, or commit messages. Use when the user asks for release notes/发布说明/变更记录. |
Release Notes
Workflow
- Group changes into Added, Fixed, Changed, and Deprecated if applicable.
- Highlight user-visible impact and breaking changes.
- Keep each entry short and user-friendly.
- Include version/date if provided.
Output format
Release:
- Version:
- Date:
Added:
- ...
Changed:
- ...
Fixed:
- ...
Breaking changes:
- ...
Notes:
- ...
Notes
- If version/date are missing, set to TBC.
- Avoid internal implementation details unless requested.