Release Notes Generator

What it does

The Release Notes Generator skill automatically creates 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 into human-readable release notes. This significantly reduces the manual effort involved in documenting software releases.

When to use it

• Automating Release Documentation: When you want to generate release notes directly from your Git repository's commit history, saving time and ensuring consistency.
• Generating Notes for Internal Teams: Quickly produce a summary of changes for developers or internal stakeholders without needing to manually compile information.
• Creating Public-Facing Changelogs: Produce formatted changelogs for public consumption, easily integrated into websites or documentation platforms.
• Streamlining DevOps Workflows: Integrate release note generation into your CI/CD pipeline for automated releases and documentation updates.

Key capabilities

• Parses Git commit history.
• Extracts information from commit messages.
• Formats extracted data into human-readable release notes.

Example prompts

• "Generate release notes for the my-project repository."
• "Create a changelog for version 1.2.0 of my-repo, using conventional commits."
• "Summarize changes in the feature-branch branch as release notes."

Tips & gotchas

The skill relies on well-formatted commit messages; ensure your team follows a consistent commit message convention (e.g., Conventional Commits) for optimal results. Providing access to the Git repository is required for the skill to function.