Agent skill

write-release-notes

Writing release notes articles for tldraw SDK releases. Use when creating new release documentation, drafting release notes from scratch, or reviewing release note quality. Provides guidance on structure, voice, and content for release files in `apps/docs/content/releases/`.

View SKILL.md on GitHub Repository
Stars 46,144
Forks 3,119

Install this agent skill to your Project

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

SKILL.md

Write release notes

This skill covers how to write a complete release notes article for a published tldraw SDK release.

Location

All release files live in apps/docs/content/releases/.

File Purpose
next.mdx Accumulates changes for the upcoming release
vX.Y.0.mdx Published releases (immutable except for patch additions)

Process

1. Identify the release

Get the version number and find the GitHub release:

bash
gh release view v4.3.0

This shows the release date, tag, and any release notes from GitHub.

2. Find all PRs in the release

List PRs merged between the previous release and this one:

bash
# Find commits between releases
git log v4.2.0..v4.3.0 --oneline --merges

# Or use gh to list PRs
gh pr list --state merged --base main --search "merged:2024-01-01..2024-02-01"

3. Fetch PR details

For each PR, get the full details:

bash
gh pr view <PR_NUMBER> --json title,body,labels,author,baseRefName

Look for:

  • ### Release notes section in PR body
  • ### API changes section in PR body
  • Labels indicating category (api, bugfix, improvement, etc.)
  • Whether "breaking" appears in the PR

Important: Only include PRs whose baseRefName is main. PRs merged into feature branches (e.g. default-shape-customization) are not yet released — they will be included when the feature branch itself is merged to main.

4. Find patch releases

List any patch releases for this minor version:

bash
gh release list | grep "v4.3"

For each patch release, find its PRs:

bash
git log v4.3.0..v4.3.1 --oneline --merges

5. Write the article

Create apps/docs/content/releases/vX.Y.0.mdx following the style guide.

  1. Write the frontmatter with version, dates, and keywords
  2. Write a 1-2 sentence introduction summarizing highlights
  3. Create featured sections for major features and breaking changes
  4. List API changes, improvements, and bug fixes
  5. Add patch release sections if applicable
  6. Add GitHub release links

6. Verify

Check that:

  • All significant PRs are represented
  • PR links are correct and formatted properly
  • Community contributors are credited
  • Breaking changes are marked with 💥
  • Sections are in the correct order

References

  • Style guide: See ../shared/release-notes-guide.md for guidance on what a release notes article should contain and how to format it.

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

tldraw/tldraw

convert-web-app

This skill should be used when the user asks to "add MCP App support to my web app", "turn my web app into a hybrid MCP App", "make my web page work as an MCP App too", "wrap my existing UI as an MCP App", "convert iframe embed to MCP App", "turn my SPA into an MCP App", or needs to add MCP App support to an existing web application while keeping it working standalone. Provides guidance for analyzing existing web apps and creating a hybrid web + MCP App with server-side tool and resource registration.

46,144 3,119
Explore
tldraw/tldraw

add-app-to-server

This skill should be used when the user asks to "add an app to my MCP server", "add UI to my MCP server", "add a view to my MCP tool", "enrich MCP tools with UI", "add interactive UI to existing server", "add MCP Apps to my server", or needs to add interactive UI capabilities to an existing MCP server that already has tools. Provides guidance for analyzing existing tools and adding MCP Apps UI resources.

46,144 3,119
Explore
tldraw/tldraw

migrate-oai-app

This skill should be used when the user asks to "migrate from OpenAI Apps SDK", "convert OpenAI App to MCP", "port from window.openai", "migrate from skybridge", "convert openai/outputTemplate", or needs guidance on converting OpenAI Apps SDK applications to MCP Apps SDK. Provides step-by-step migration guidance with API mapping tables.

46,144 3,119
Explore
tldraw/tldraw

create-mcp-app

This skill should be used when the user asks to "create an MCP App", "add a UI to an MCP tool", "build an interactive MCP View", "scaffold an MCP App", or needs guidance on MCP Apps SDK patterns, UI-resource registration, MCP App lifecycle, or host integration. Provides comprehensive guidance for building MCP Apps with interactive UIs.

46,144 3,119
Explore
tldraw/tldraw

pr-walkthrough

Create a narrated video walkthrough of a pull request with code slides and audio narration. Use when asked to create a PR walkthrough, PR video, or walkthrough video.

46,144 3,119
Explore
tldraw/tldraw

write-docs

Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.

46,144 3,119
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results