write-release-notes

Name: write-release-notes
Availability: InStock
Author: tldraw

Compose publication-ready release notes for tldraw SDK releases from GitHub data.

49.7k|3.4k|Updated May 9, 2021

Search Tags:#documentation #SDK #docs #release-management #style-guide #release-notes #PR-aggregation

Ready to run

npx skills add https://github.com/tldraw/tldraw --skill write-release-notes

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: write-release-notes
Source: https://github.com/tldraw/tldraw/tree/main/.claude/skills/write-release-notes
Command: npx skills add https://github.com/tldraw/tldraw --skill write-release-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill guides teams on producing complete, publication-ready release notes for tldraw SDK releases, ensuring consistency across versions and improving documentation quality.

Core Features & Use Cases

Structured release notes templates for upcoming and published versions.
PR aggregation and data extraction to capture changes, API updates, and fixes.
Style-guide aligned formatting and quality checks to ensure consistent voice and structure.
Use Case: Draft v4.3.0 notes by consolidating the GitHub release data and related PRs into a single, publish-ready article.

Quick Start

Draft a complete release notes article for a published tldraw SDK release using the GitHub release data and merged PR details. Example: draft v4.3.0 release notes by retrieving the release with gh release view v4.3.0 and listing PRs merged since v4.2.0.

Frequently Asked Questions about write-release-notes

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

FAQPage Schema

How do I generate release notes for a published SDK version?▼

Generate release notes by retrieving the GitHub release metadata and aggregating all merged PRs since the previous version. This consolidates API changes, improvements, and bug fixes into a single, publication-ready article.

What is the best way to aggregate PRs for SDK release documentation?▼

Aggregating PRs for SDK release documentation involves extracting merged PR details and categorizing them into API changes, improvements, and fixes. The process applies a defined style guide to ensure consistent voice and structure across versions.

Can I use GitHub release data to structure API changes and bug fixes?▼

Yes, you can use GitHub release data to structure API changes and bug fixes. The process extracts details from the release metadata and related PRs, organizing them into a structured, publication-ready article.

Do I need a style guide to draft consistent SDK release notes?▼

Yes, a style guide is required to draft consistent SDK release notes. It provides the formatting rules and quality checks needed to ensure a consistent voice and structure across all published versions.

What limitations exist when automating release notes from PR aggregation?▼

Limitations include relying entirely on the accuracy of repository release metadata and PR details. The generated notes depend on the defined style guide, meaning incomplete PR data may result in inconsistent documentation.

How do I draft v4.3.0 release notes using GitHub release data?▼

Draft v4.3.0 release notes by retrieving the release with gh release view v4.3.0 and listing PRs merged since v4.2.0. This aggregates the data into a single, publish-ready article.