Generate Release Notes

What it does

This skill automatically generates release notes from commit messages. It parses a repository's commit history, extracts relevant information from commit messages (e.g., issue numbers, feature descriptions), and formats this into human-readable release notes suitable for distribution to users or internal teams. The generated release notes can be customized based on predefined templates or configurations.

When to use it

• Automating repetitive tasks: Reduce the manual effort involved in compiling release notes after each deployment cycle.
• Improving consistency: Ensure consistent formatting and content across all release announcements.
• Linking commits to issues: Automatically include issue tracker references (e.g., Jira tickets) within release notes for better traceability.
• Generating changelogs: Create a comprehensive history of changes in your project, easily accessible to developers and users.

Key capabilities

• Commit message parsing
• Issue tracking integration
• Release note formatting
• Customizable templates

Example prompts

• "Generate release notes for the main branch."
• "Create a release notes file in Markdown format from the last 5 commits."
• "Generate release notes, including Jira ticket numbers from commit messages."

Tips & gotchas

The skill's effectiveness depends on well-formatted and consistent commit messages. Ensure your team adheres to a defined commit message convention for optimal results.