generate-release-notes

Generate categorized markdown release notes from Git tag changes for OWASP Juice Shop.

13.6k|19.0k|Updated Sep 19, 2014
One-click install
npx skills add https://github.com/juice-shop/juice-shop --skill generate-release-notes-juice-shop
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-release-notes
Source: https://github.com/juice-shop/juice-shop/tree/main/.ai/skills/generate-release-notes
Command: npx skills add https://github.com/juice-shop/juice-shop --skill generate-release-notes-juice-shop

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the problem of writing release notes that are complete, consistently formatted, and properly categorized—using the same iconography and structure as prior Juice Shop releases.

Core Features & Use Cases

  • Change detection since the last release: Collects commits, tags, PR/contributor info, and identifies differences in key files (runtime, dependencies, config, challenges, UI, and i18n).
  • Iconographic categorization & status flags: Maps changes to the correct emoji-based sections (e.g., Runtime, Challenges, Frontend, UI, Docker, Bugfixes) and applies disclaimer triggers for ⚡/⚠️/📜 breaking or policy-relevant updates.
  • Release-ready formatting & refinement: Produces bullet-point notes with kudos attribution, PR/commit references when available, and ensures coverage against a checklist.

Quick Start

Ask the AI to generate release notes for Juice Shop by comparing the latest tag to the current HEAD commit range, and output the markdown using the established emoji section order and disclaimer rules.

Frequently Asked Questions about generate-release-notes

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

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

To generate release notes from git history, this Skill analyzes commits, tags, and PRs since the latest tag, then formats the output into categorized markdown sections with contributor kudos and emoji status icons.

How do I categorize changelog entries by runtime, frontend, and Docker changes?

Categorizing changelog entries by runtime, frontend, and Docker changes is done by checking file diffs across documented project paths and mapping them to the correct emoji-based markdown sections for each specific area.

What is the best way to format markdown release notes with consistent emoji sections?

The best way to format markdown release notes with consistent emoji sections is to apply established iconography rules that map changes to specific categories like Runtime, Challenges, and Bugfixes, complete with status flags and disclaimer triggers.

Can I automatically attribute contributor kudos and PR references in my changelog?

Yes, you can automatically attribute contributor kudos and PR references in your changelog by extracting contributor information and commit data from the git history range between the latest tag and HEAD.

Does generating release notes require a specific git-based project setup?

Generating release notes requires a git-based project setup with tag and commit history, PR discovery, and trackable file diffs across documented project paths like runtime, dependencies, config, challenges, UI, and i18n.

When should I add breaking change disclaimers to release notes?

You should add breaking change disclaimers to release notes when the git history analysis detects policy-relevant updates or breaking changes that trigger the required ⚡, ⚠️, or 📜 status icons and disclaimer flags.