release-notes-generator

Generate Markdown sprint release notes from the latest ORE Sprint Backlog file.

25|5|Updated Jun 15, 2024
One-click install
npx skills add https://github.com/OreStudio/OreStudio --skill release-notes-generator-orestudio
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-notes-generator
Source: https://github.com/OreStudio/OreStudio/tree/main/.claude/skills/relese-notes-generator
Command: npx skills add https://github.com/OreStudio/OreStudio --skill release-notes-generator-orestudio

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation of release notes from an ORE Sprint Backlog file, streamlining sprint communication and documentation.

Core Features & Use Cases

  • Automated Backlog Conversion transforms the latest sprint backlog from doc/agile/v0/ into a structured release notes document.
  • Markdown & Org-Mode Output formats notes in Markdown and embeds a new "AI Generated Sprint Summary" section in Org-Mode.
  • Use Case: a team can quickly publish a consistent sprint summary after each sprint without manual drafting.

Quick Start

Use the release-notes-generator to generate notes from the latest sprint backlog located in doc/agile/v0/. The latest backlog is the one with the highest sprint number; place the resulting summary under a new "AI Generated Sprint Summary" section.

Frequently Asked Questions about release-notes-generator

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

FAQPage Schema
How do I automate sprint release notes from a backlog file?

Markdown release notes are automatically generated and embedded into an org-mode block within the backlog file. The summary is saved under a new 'AI Generated Sprint Summary' section, ensuring structured documentation.

How does the generator select which sprint backlog to summarize?

To generate release notes, place your sprint backlog files under doc/agile/v0/ with clear sprint numbering. The tool identifies the highest sprint number automatically and appends the resulting summary under a new 'AI Generated Sprint Summary' section.

Can I use this to generate release notes for a specific sprint instead of the latest one?

No, this Skill is designed to automatically select and process only the latest sprint backlog, defined as the file with the highest sprint number. It does not support manually specifying an older sprint backlog for release note generation.

Does the release notes generator work with backlog files outside the doc/agile/v0/ directory?

No, the release notes generator operates specifically on backlog files located under doc/agile/v0/. Backlog files stored in other directories will not be recognized or processed by the automated sprint summary generation logic.