addon-release-notes

Generate release notes for addon packages from PR commits and version bumps.

Updated May 11, 2026
One-click install
npx skills add https://github.com/thachrocky12345/local-agent-train-workstation --skill addon-release-notes-thachrocky12345
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: addon-release-notes
Source: https://github.com/thachrocky12345/local-agent-train-workstation/tree/main/qvac/.cursor/skills/addon-release-notes
Command: npx skills add https://github.com/thachrocky12345/local-agent-train-workstation --skill addon-release-notes-thachrocky12345

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing release notes for addon packages requires manually reviewing commits, extracting PR references, and verifying version bumps, which is tedious and error-prone. This Skill automates that process by collecting changes between main and the PR branch, validating the version bump, and producing a formatted release notes file. ## Core Features & Use Cases - Mandatory Version Bump Validation: Compares package.json against main and stops with a warning if the version was not bumped. - PR Extraction and Enrichment: Extracts PR numbers from commit messages and fetches titles and URLs via the GitHub CLI. - Formatted Release Notes Output: Generates a release-notes/vX.Y.Z.md file with narrative sections for breaking changes, features, bug fixes, and a PR list. - Use Case: While preparing a release of the OCR addon, ask the assistant to generate release notes; it validates the version bump, gathers PRs #67 and #70, and writes a polished v0.4.0 release notes file. ## Quick Start Ask the assistant to generate release notes for the current addon package before merging your PR to main.

Frequently Asked Questions about addon-release-notes

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

FAQPage Schema
How do I generate release notes for an addon package?

Run the release notes generation workflow on your PR branch. It compares commits between main and HEAD, extracts PR numbers, fetches PR details with gh pr view, and writes a formatted release-notes/vX.Y.Z.md file.

What happens if I forget to bump the package version?

The workflow compares package.json between main and HEAD and stops with a warning if the version is unchanged. You must bump the version, commit and push the change, then re-run the command.

Which addon packages does this release notes workflow support?

It supports non-SDK addon packages including decoder-audio, embed-llamacpp, llm-llamacpp, translation-nmtcpp, tts-onnx, transcription-whispercpp, and ocr-onnx, each mapped to a readable display name in the title.

Does the release notes generator include uncommitted changes?

No. Uncommitted changes and untracked files are explicitly ignored. Only committed changes on the PR branch relative to main are included in the generated release notes.

What format do the generated release notes follow?

The output is a markdown file with a title, a short introduction, narrative prose sections for breaking changes, new APIs, features, bug fixes, and other items, plus a Pull Requests section listing PR numbers, URLs, and titles.