Release Notes Generator

What it does

This skill automatically generates release notes from commit messages. It parses a repository's commit history, extracts relevant information from each commit message (like issue numbers and descriptions), and formats this data into human-readable release notes. The generated notes can be customized with different templates or formatting options.

When to use it

• Automating Release Note Creation: When preparing for a new software release and needing to quickly compile comprehensive release notes.
• Generating Notes from Existing Repositories: To create release notes for projects that already have a substantial commit history.
• Standardizing Release Note Format: Enforce consistency in how release notes are presented across different projects or teams.
• Reducing Manual Effort: Minimize the time and effort spent manually writing and formatting release notes.

Key capabilities

• Parses Git commit messages
• Extracts information from commit descriptions
• Generates human-readable release notes
• Customizable output format (templates)

Example prompts

• "Generate release notes for the 'my-project' repository."
• "Create a release note document for version 1.2.0 of my project, using the standard template."
• “Can you summarize the changes in the last three months into release notes?”

Tips & gotchas

• The quality of the generated release notes depends heavily on well-formatted and descriptive commit messages. Ensure your team follows a consistent commit message style.