writing-release-notes

Generate categorized markdown release notes from git history and version files.

13|2|Updated Jan 22, 2023
One-click install
npx skills add https://github.com/meirm/askGPT --skill writing-release-notes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-release-notes
Source: https://github.com/meirm/askGPT/tree/main/src/askGPT/data/builtin_skills/writing-release-notes
Command: npx skills add https://github.com/meirm/askGPT --skill writing-release-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate professional release notes and changelog entries by analyzing git history and version information to deliver polished documentation.

Core Features & Use Cases

  • Version-aware: Reads version files and commits to categorize changes (Added, Changed, Fixed, etc.)
  • Structured Output: Generates release notes with sections and upgrade notes.
  • Documentation-ready: Produces CHANGELOG or RELEASE_NOTES for distribution or deployment notes.

Quick Start

Generate release notes for the current project: summarize recent changes into a CHANGELOG.

Frequently Asked Questions about writing-release-notes

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

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

Release notes can be generated automatically by analyzing git commits and version files. This Skill reads your git history, detects version changes from files like package.json or Cargo.toml, categorizes commits by type (Added, Fixed, Changed, etc.), and outputs a formatted markdown changelog with dates and contributor references.

Can I create a changelog from conventional commits?

Yes. Conventional commits provide structured metadata that enables automatic categorization into sections like Added, Fixed, Deprecated, and Security. The Skill parses these commit messages alongside your git history to group related changes and generate well-organized release notes.

What version file formats does this support?

The Skill detects release types and version information by parsing package.json, pyproject.toml, Cargo.toml, and similar version files across different build ecosystems. It reads the current version to determine whether changes constitute a major, minor, or patch release.

How do I automate changelog generation for deployment?

Configure the Skill to run as part of your release workflow. It analyzes recent commits and version changes, then outputs a CHANGELOG or RELEASE_NOTES markdown file ready for distribution or deployment documentation without manual editing.

Does this work across different programming languages?

Yes. The Skill applies to software projects across languages and build ecosystems by analyzing git history and version files common to most projects—it doesn't depend on language-specific tooling, making it suitable for polyglot teams and monorepos.

What structured sections does the release notes output include?

Generated release notes include categorized sections for Added, Changed, Fixed, Deprecated, Removed, and Security changes. Each section groups related commits, includes dates, contributor references, and produces professional markdown formatted for immediate publication.