release-notes

Generate release-notes.md for evitaDB releases from tags, commits, and issues.

70|7|Updated Feb 22, 2023
One-click install
npx skills add https://github.com/FgForrest/evitaDB --skill release-notes-fgforrest
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/FgForrest/evitaDB/tree/main/.claude/skills/release-notes
Command: npx skills add https://github.com/FgForrest/evitaDB --skill release-notes-fgforrest

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating consistent, rich release notes for evitaDB releases is time-consuming. This Skill automates the process by generating a deterministic skeleton and enriching it with concise user-facing prose for breaking changes and notable features, then writes the result to release-notes.md.

Core Features & Use Cases

  • Deterministic skeleton generation: Produces the standard four-section structure in the correct order.
  • Prose enrichment: Adds short, user-facing explanations for breaking changes and "interesting" features.
  • CI and local run support: Invokable locally as /release-notes and executable in CI release workflows to publish release notes.

Quick Start

Run /release-notes to generate release notes for the next evitaDB release.

Frequently Asked Questions about release-notes

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

FAQPage Schema
How do I automate release notes generation from git commits and issues?

You can automate release notes generation by parsing git commits, tags, and issues to produce a deterministic skeleton, then enriching breaking changes and features with user-facing prose before writing the result to a markdown file.

How do I generate a change log for both major and patch releases in a CI workflow?

You can generate a change log for major and patch releases by invoking the automation command in your CI release workflow, which parses repository inputs and outputs a ready-to-publish release-notes.md file.

What is the best way to structure release notes for breaking changes and new features?

The best way to structure release notes is using a deterministic four-section skeleton generator, which automatically orders content and enriches breaking changes and interesting features with concise prose explanations.

Can I run the release notes automation locally instead of in a CI pipeline?

Yes, you can run the release notes automation locally by invoking the dedicated slash command, which parses repository inputs and generates the final release notes markdown file directly on your machine.

Do I need any external dependencies to generate evitaDB release notes?

No external dependencies are required to generate evitaDB release notes; the automation skill operates standalone by parsing existing repository tags, commits, and issues to produce the final markdown output.

Why does my automated change log lack detailed explanations for breaking changes?

Automated change logs often lack detail because they only list raw commits; this solution resolves that by enriching breaking changes and notable features with concise, user-facing prose during generation.