Where are the generated release notes saved?

The skill is configured to create or update MDX files within the apps/docs/content/releases/ directory of the repository.

How does it handle community credits?

The skill fetches author information from each PR included in the release to ensure every contributor is recognized in the final documentation.

Can it identify breaking changes automatically?

Yes, it scans PR bodies for 'API changes' and 'breaking' keywords, marking them with specific indicators like the 💥 emoji as per the style guide.

Does it support patch releases?

Absolutely. It can list patch releases for a minor version and append their specific PR data to the main release article.

How does this skill gather release information?

It uses the GitHub CLI (gh) and Git commands to fetch pull requests, release tags, and commit history between specific version tags.

Release Notes Writer

Name: Release Notes Writer
Author: tldraw

bytldraw

•

45,372

•

콘텐츠 관리

Generates structured, high-quality release notes articles for SDK updates by aggregating PR data and technical changes.

This skill automates the complex task of drafting release documentation for the tldraw SDK by programmatically fetching pull request details, identifying API changes, and organizing them into standardized MDX files. It streamlines the workflow between code merging and public communication, ensuring that breaking changes are clearly highlighted with appropriate signifiers and that community contributors are properly credited. By leveraging GitHub CLI and git history, it provides a consistent voice and structure for all release logs, making it an essential tool for maintaining high-quality developer documentation.

주요 기능

01Verification checks for link formatting and section ordering

02Automated aggregation of PR titles, bodies, and labels via GitHub CLI

0345,372 GitHub stars

04Identification of breaking changes and API modifications for highlight sections

05Standardized MDX generation for minor and patch release versions

06Automatic attribution and credit for community contributors

사용 사례

01Ensuring consistency in voice and formatting across technical change logs

02Summarizing recent patch fixes and PRs into an existing release article

03Drafting comprehensive documentation for a major or minor SDK release

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tldraw/tldraw write-release-notes

For use in Claude.ai and ChatGPT

Download Skill