release-note

Generate semver-compliant release notes from git history using Conventional Commits.

13|5|Updated May 18, 2024
One-click install
npx skills add https://github.com/techdiary-dev/techdiary.dev --skill release-note-techdiary-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-note
Source: https://github.com/techdiary-dev/techdiary.dev/tree/main/.claude/skills/release-note
Command: npx skills add https://github.com/techdiary-dev/techdiary.dev --skill release-note-techdiary-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate a semver-compliant release note from git history, streamlining versioned releases and ensuring consistency across teams.

Core Features & Use Cases

  • Automates the creation of release notes by parsing git history and identifying relevant commits.
  • Categorizes commits according to Conventional Commits and semantic rules (Breaking Changes, Features, Bug Fixes, Other).
  • Produces a draft release note aligned with Semantic Versioning and ready for review or publishing in GitHub Releases.
  • Use Case: When preparing a new software release, generate an accurate release note summarizing changes, improvements, and fixes.

Quick Start

Run the skill against a repository to generate a release note for the current project.

Frequently Asked Questions about release-note

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate release notes from git history automatically?

To generate release notes from git history automatically, you can use a tool that parses your repository commits, categorizes them using Conventional Commits, and drafts a document aligned with Semantic Versioning for immediate review.

How does Conventional Commits categorization work for semantic versioning?

Conventional Commits categorization for semantic versioning works by parsing commit messages to identify breaking changes, new features, and bug fixes, then mapping these signals to determine the appropriate version bump and structure the release notes.

Can I use automated release note generation in a CI/CD pipeline?

Yes, you can use automated release note generation in a CI/CD pipeline. It is designed to parse git history during CI/CD runs or release planning to ensure consistent, auditable notes are produced for every deployment.

What is the best way to prepare semver-compliant release notes for GitHub Releases?

The best way to prepare semver-compliant release notes for GitHub Releases is to automate drafting from git history. This identifies the current version and categorizes commits to produce a document ready for publishing.

Do I need to follow Conventional Commits to automate my versioning workflow?

Yes, you need to follow Conventional Commits to automate your versioning workflow effectively. The automation relies on these commit signals to accurately categorize changes and determine the correct Semantic Versioning bump.