Agent skill

Generate Release Notes

by open-edge-platform in open-edge-platform/edge-ai-libraries

Generate formatted release notes for a specific folder/module in a repository by comparing two git branches or tags.

Apache-2.0Auto-check passedDevelopment

Install Generate Release Notes

skills CLI
$ npx skills add open-edge-platform/edge-ai-libraries --skill generate-release-notes -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install open-edge-platform/edge-ai-libraries generate-release-notes --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/open-edge-platform/edge-ai-libraries.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.github/skills/generate-release-notes .claude/skills/generate-release-notes && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
generate-release-notes
GitHub stars
169
Token cost
~1.8k tokens
SKILL.md length
743 words
Files
2 (incl. assets)
Skills in repo
29
Repo updated
First seen
Licence
Apache-2.0

At a glance

Generate formatted release notes for a specific folder/module in a repository by comparing two git branches or tags.

  • Works in 6 steps: Gather Git History → Categorize Changes → Write the Release Notes → …
  • The user mentions release notes
  • SKILL.md covers When to Use, Inputs Required and Procedure
  • Calls git

What it does

Generate Release Notes is an agent skill from open-edge-platform/edge-ai-libraries. Generate formatted release notes for a specific folder/module in a repository by comparing two git branches or tags. Use this skill whenever the user mentions release notes, changelog, what changed between branches, version summary, release prep, or wants to document what is new or fixed in a release, especially when they mention a component folder or subproject path. Compares commits and diffs between a base branch or tag and a release branch or tag for the requested folder only, then produces structured…

Its SKILL.md is about 1.8k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including assets (for example `assets/release-notes-template.md`).

It sits in Development, covering Changelog and release notes. The repository describes itself as: Libraries, microservices, tools, and other reference software, supporting development of performance-optimized Edge AI applications. The licence is Apache-2.0.

When your agent uses it

  • The user mentions release notes
  • What changed between branches
  • Version summary
  • Wants to document what is new

Example prompts

  • “/generate-release-notes”

Workflow steps

6 steps, taken from the step headings in SKILL.md.

  1. Gather Git History
  2. Categorize Changes
  3. Write the Release Notes
  4. Locate or Create the Release Notes File
  5. Reference Example
  6. Review with User

What it can do on your machine

Read from SKILL.md and the folder at commit 3084578. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Generate Release Notes loads about 1.8k tokens when it runs. Until then it costs about 194 tokens; SKILL.md has 743 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~194
When it runs · the whole SKILL.md, loaded when a task matches
~1.8k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from open-edge-platform/edge-ai-libraries at commit 3084578, republished under its Apache-2.0 licence (© open-edge-platform). 743 words, ~1,799 tokens.

Download SKILL.mdSave it as .claude/skills/generate-release-notes/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
generate-release-notes
description
Generate formatted release notes for a specific folder/module in a repository by comparing two git branches or tags. Use this skill whenever the user mentions release notes, changelog, what changed between branches, version summary, release prep, or wants to document what is new or fixed in a release, especially when they mention a component folder or subproject path. Compares commits and diffs between a base branch or tag and a release branch or tag for the requested folder only, then produces structured Markdown release notes with New, Improved, and Fixed bold-heading sections, bold bullet titles, and an intro summary sentence, following the Time Series Analytics product style. Always use this skill rather than writing release notes freehand.
license
Apache-2.0
metadata.tags
release-notes changelog

Generate Release Notes

When to Use

  • Preparing a new release and need formatted release notes
  • Comparing changes between two branches (e.g., main vs release-2026.1.0)
  • Summarizing what is new, improved, or fixed in a version
  • Appending a new version section to an existing release notes file

Inputs Required

Before starting, ask the user for these values if not already provided:

InputExampleNotes
product nameTime Series AnalyticsRequired
Base branchmain, release-2026.0Required
Release branchrelease-2026.1.0Required
Version number2026.1Optional — auto-derived from the release branch name if not provided (see Step 3)
Release month and yearJune 2026Required
Folder path in repomicroservices/time-series-analyticsRequired

If the user has not specified the product name, ask them: "What is the product name to include in the release notes? (e.g., Time Series Analytics)"


Procedure

Step 1: Gather Git History

Run these commands against the repo being released and scope to the requested folder path:

bash
# All commits unique to the release branch (no merge commits)
git log <base-branch-or-tag>..<release-branch-or-tag> --oneline --no-merges -- <folder-path>

# Files changed and their change volumes
git diff <base-branch-or-tag>..<release-branch-or-tag> --stat -- <folder-path>

# Full diff for detailed analysis
git diff <base-branch-or-tag>..<release-branch-or-tag> -- <folder-path>

If the change volume is large, scope the diff further to key subdirectories under the selected folder:

bash
git diff <base-branch-or-tag>..<release-branch-or-tag> -- <folder-path>/<path/to/component>
Step 2: Categorize Changes

Group every change into one of the three categories below. When in doubt, prefer Improved over New unless the feature is entirely absent from the base branch.

CategoryWhat belongs here
NewBrand-new features, APIs, components, scripts, or capabilities that did not exist in the base branch
ImprovedEnhancements, refactors, performance improvements, dependency/image upgrades, documentation updates, security patches, renames
FixedBug fixes and error corrections — omit this section entirely if there are no bug fixes

Handling ambiguous changes:

  • Downgrades or reversals (e.g., base image rolled back from 24.04 to 22.04, a feature removed): still list under Improved if the change was intentional, and describe why (e.g., "updated to align with supported baseline"). If the change removes user-visible functionality, note it plainly.
  • Very small changes (typo fix, single-line config tweak): group several into one bullet rather than listing each separately.
  • Security dependency bumps: always call out under Improved with a **Security**: bullet, naming the package and CVE or vulnerability description if known.
Show full SKILL.md (408 more words)Show less
Step 3: Write the Release Notes

Follow the release notes format template exactly.

Formatting rules:

  • File heading: # Release Notes: <product_name> — use the product name supplied by the user (e.g., # Release Notes: Time Series Analytics).

  • Version heading: ## Version <X.Y> — always ##, never # or ###

    Versioning strategy: The version number follows the YYYY.MINOR scheme where YYYY is the calendar year and MINOR is the sequential release number within that year (starting at 0). Derive it from the release branch name by stripping the release- prefix and any trailing patch segment (.0):

    • release-2026.0 → 2026.0
    • release-2026.1.0 → 2026.1
    • release-2026.2.0 → 2026.2

    MINOR increments sequentially within a calendar year (e.g., 2026.0, 2026.1, 2026.2, …). If the user has not specified the version number, derive it from the release branch using this rule and confirm with the user before writing.

  • Date line immediately below: **<Month Year>** (bold, on its own line, NOT embedded in the heading)

  • One-sentence introductory paragraph that names the 2–4 most significant highlights in bold inline, ending with and various fixes and documentation improvements. (or similar closing clause)

  • Each category as a bold paragraph heading — write exactly **New**, **Improved**, **Fixed** — these are NOT markdown ## or ### headers, just bold text on its own line

  • Each bullet: - **Feature Name**: Description sentence(s).

    • The bold title is the short name of the feature/change
    • The colon goes outside the bold markers: **Name**: not **Name:**
    • The description follows a colon, starts lowercase (unless a proper noun), and ends with a period
    • Group related small changes into a single bullet rather than splitting into many bullets
  • Separate versions with a --- horizontal rule

  • Do NOT include code blocks, tables, bash commands, or environment variable listings in release notes — keep entries high-level and human-readable

Intro sentence patterns (choose the one that fits):

This release introduces **X**, **Y**, and **Z**, along with various fixes and documentation improvements.

This release introduces **X** and **Y**, along with **updated Z** and **documentation improvements**.
Step 4: Locate or Create the Release Notes File

For a folder-scoped release, the canonical path is:

<folder-path>/docs/user-guide/release-notes.md

If the file does not exist, create it. If it already exists, prepend the new version section above the previous most-recent version entry (do not replace existing content).

Step 5: Reference Example

The authoritative format example is the existing release notes file for the selected folder:

<folder-path>/docs/user-guide/release-notes.md

When uncertain about formatting or section structure, re-read that file.

Step 6: Review with User

After drafting, ask the user to confirm:

  1. Are all significant changes captured?
  2. Are the categorizations (New / Improved / Fixed) correct?
  3. Is the intro summary accurate?
  4. Are there any sensitive internal details that should be removed?

Apply any corrections before writing to disk.

© open-edge-platform, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (assets) in .github/skills/generate-release-notes of open-edge-platform/edge-ai-libraries.

  • SKILL.md
  • assets/release-notes-template.md

Open the folder on GitHubat commit 3084578

Compare with similar skills

Generate Release Notes next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Generate Release Notes compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Generate Release Notes this skillopen-edge-platform/edge-ai-libraries169—~1.8kAutomated safety check: PassApache-2.0
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
StarRocks Release NotesStarRocks/starrocks12k—~1.9kAutomated safety check: NotesApache-2.0
Cutting A ReleaseTriliumNext/Trilium38k—~3.2kAutomated safety check: PassAGPL-3.0
React Router Release Notes Prepremix-run/react-router57k—~1.1kAutomated safety check: PassMIT
Mole CLI Release Flowtw93/Mole70k—~2.5kAutomated safety check: PassGPL-3.0

Similar skills

  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • StarRocks Release Notes

    StarRocks/starrocks

    Drafts English release notes for a StarRocks patch release from the PRs merged into its release branch, then opens a documentation PR and hands translation to /translate.

    12k GitHub stars~1.9k tokensUpdated today
    DevelopmentAuto-check: notes
  • Cutting A Release

    TriliumNext/Trilium

    A skill your agent uses when cutting, preparing, or debugging a Trilium release — bumping the monorepo version, tagging, or diagnosing a failed "Release" workflow run.

    38k GitHub stars~3.2k tokensUpdated today
    DevelopmentAuto-check passed
  • React Router Release Notes Prep

    remix-run/react-router

    Polishes pending React Router change files before the versioning scripts run, and decides whether a long-form What's Changed section is warranted.

    57k GitHub stars~1.1k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Runbook for assessing and executing a Mole CLI release: distribution channels, pre-flight checks, capital-V tags, build artifacts and the handoff to curated release notes.

    70k GitHub stars~2.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Release

    PrefectHQ/fastmcp

    Cut a FastMCP release end to end. An agent skill from PrefectHQ/fastmcp.

    28k GitHub stars~2.9k tokensUpdated today
    DevelopmentAuto-check passed

More from open-edge-platform/edge-ai-libraries

All 29 skills in this repo
  • Time Series Analytics User

    open-edge-platform/edge-ai-libraries

    Build a new time-series analytics use case on top of the deployed Time Series Analytics microservice — bring it up with Docker Compose (from a repo clone, or by fetching the compose files from…

    169 GitHub stars~3.1k tokensUpdated today
    Auto-check passed
  • Vss Add Nest Module

    open-edge-platform/edge-ai-libraries

    Scaffolds and wires a new NestJS service/module for the Video Search & Summarization sample app's pipeline-manager using the repo's real conventions.

    169 GitHub stars~2.5k tokensUpdated today
    Auto-check passed
  • Chatqna Helm Deploy

    open-edge-platform/edge-ai-libraries

    Deploy Chat Question-and-Answer Core to Kubernetes using Helm (OpenVINO CPU, OpenVINO GPU, or Ollama), including values.yaml configuration, helm install/upgrade, deployment verification, uninstall…

    169 GitHub stars~2.3k tokensUpdated today
    Auto-check passed
  • Generate Changelog

    open-edge-platform/edge-ai-libraries

    Generates or updates CHANGELOG.md by analyzing git commit history between two branches, tags, or revisions in ANY git repository or folder.

    169 GitHub stars~3.1k tokensUpdated today
    Auto-check passed
  • Vss Deploy

    open-edge-platform/edge-ai-libraries

    Deploys and manages VSS through setup.sh and its Docker Compose overlays.

    169 GitHub stars~4.1k tokensUpdated today
    Auto-check passed
  • Vss Deploy Helm

    open-edge-platform/edge-ai-libraries

    A skill your agent uses whenever a developer needs to deploy VSS to Kubernetes, helm install VSS, configure values.yaml for VSS, or run VSS on k8s with GPU/vLLM for the…

    169 GitHub stars~3.8k tokensUpdated today
    Auto-check passed

Categories

Questions about Generate Release Notes

What does Generate Release Notes do?

Generate formatted release notes for a specific folder/module in a repository by comparing two git branches or tags. Generate Release Notes is an agent skill from open-edge-platform/edge-ai-libraries. Generate formatted release notes for a specific folder/module in a repository by comparing two git branches or tags.

When should I use Generate Release Notes?

Generate Release Notes fits situations like: the user mentions release notes; what changed between branches; version summary; wants to document what is new.

How do I install Generate Release Notes in Claude Code?

Run `npx skills add open-edge-platform/edge-ai-libraries --skill generate-release-notes -a claude-code`. Or copy the skill folder (.github/skills/generate-release-notes in open-edge-platform/edge-ai-libraries) into .claude/skills/generate-release-notes in your project. Claude Code loads it when a task matches its description.

How do I install Generate Release Notes in Codex?

Run `npx skills add open-edge-platform/edge-ai-libraries --skill generate-release-notes -a codex`. Or copy the skill folder (.github/skills/generate-release-notes in open-edge-platform/edge-ai-libraries) into .agents/skills/generate-release-notes in your project. Codex loads it when a task matches its description.

Can I use Generate Release Notes in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add open-edge-platform/edge-ai-libraries --skill generate-release-notes -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/generate-release-notes, .gemini/skills/generate-release-notes, .github/skills/generate-release-notes and .opencode/skills/generate-release-notes in your project.

What does Generate Release Notes need to run?

Going by SKILL.md and its folder, Generate Release Notes needs the command-line tools its instructions call (git).

Does Generate Release Notes access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Generate Release Notes safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Generate Release Notes use?

Generate Release Notes is published under the Apache-2.0 licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Generate Release Notes use?

About 1.8k tokens (SKILL.md is roughly 7.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Generate Release Notes?

Skills that share tags, products or a category with Generate Release Notes: Simple English (moeru-ai/airi, 50k stars), StarRocks Release Notes (StarRocks/starrocks, 12k stars), Cutting A Release (TriliumNext/Trilium, 38k stars) and React Router Release Notes Prep (remix-run/react-router, 57k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Generate Release Notes?

open-edge-platform (a GitHub organization) maintains it in open-edge-platform/edge-ai-libraries, which has 169 GitHub stars. The repository holds 29 skills in this directory. The repository was last updated on October 8, 2026.

Source: open-edge-platform/edge-ai-libraries on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.