skills.rest
boundless-xyz
boundless-xyzOFFICIAL
Explore all skills by this author →
GitHub

release-notes

Generate release notes with changelog and upgrade guide from PR metadata.

195|172|Updated Sep 25, 2024
Search Tags:#changelog#documentation#migration-guide#release-notes#pr-review#broker#boundless
One-click install
npx skills add https://github.com/boundless-xyz/boundless --skill release-notes-boundless-xyz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/boundless-xyz/boundless/tree/main/.claude/skills/ops-release-notes
Command: npx skills add https://github.com/boundless-xyz/boundless --skill release-notes-boundless-xyz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Internal — for Boundless team members only. Generate release notes for a new Boundless version by collecting PR details, analyzing code changes, and producing prover-facing documentation with config examples, migration guides, and worked examples. Use when the user wants to write release notes, changelog entries, or upgrade guides.

Core Features & Use Cases

  • Gather inputs such as the release version, previous tag, key PRs or features to highlight, and any current context to ensure realistic examples.
  • Research PRs and changes by fetching PR metadata, reading related code changes, reading broker configuration templates, and examining deployment docs to produce accurate notes.
  • Write structured notes with an overview, a changelog link, per-feature sections describing the change and its impact, and an Upgrade Notes section with action items.
  • Output prover-facing documentation including config examples, migration guides, and worked examples to help operators deploy and use the new release.

Quick Start

Provide the release version and the previous tag, then run the generator to produce the release notes.

Frequently Asked Questions about release-notes

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

FAQPage Schema
How do I generate release notes from merged pull requests?▼

Generating release notes from merged pull requests is done by fetching PR metadata via gh, analyzing the code changes, and compiling the details into a structured changelog with per-feature sections. The output includes an overview and a changelog link.

How do I write a migration guide for a new protocol release?▼

Writing a migration guide for a new protocol release involves analyzing code changes and broker configuration templates to produce prover-facing documentation. The output provides action items, config examples, and worked examples to help operators deploy the upgrade.

What do I need to create a changelog and upgrade guide for operators?▼

To create a changelog and upgrade guide for operators, you need the release version, the previous tag, and key PRs to highlight. The generator fetches PR metadata and reads deployment docs to produce accurate, structured notes.

Does this release notes generator read broker configuration templates?▼

Yes, this release notes generator reads broker configuration templates. It examines these templates alongside deployment docs and PR metadata to ensure the generated changelog entries and config examples are accurate for operators.

Can I automate changelog creation for Boundless protocol updates?▼

You can automate changelog creation for Boundless protocol updates by providing the release version and previous tag. The generator researches PRs and related code changes to output structured sections and migration notes automatically.

What is the best way to structure upgrade notes for prover-facing documentation?▼

Structuring upgrade notes for prover-facing documentation is best done by separating per-feature sections that describe the change and its impact. The output includes a dedicated Upgrade Notes section with action items, config examples, and worked samples.

Related Skills

Explore More Content & Communication Skills→
Zidane786Zidane786

release

Coordinate version checks, file updates, and PR creation for Kimi Code CLI releases.

Community
Advanced
Wilder1222Wilder1222
2

ship

Automate release workflows to verify, build, test, deploy, and announce software releases.

Community
Advanced
Xunzi229Xunzi229

auto-doc

Analyze git diffs to update README and CHANGELOG entries.

Community
Intermediate
NITRR-OfficialNITRR-Official
4

release-notes-generation

Generate GitHub release notes from conventional commit messages and Markdown files.

Official
Intermediate