update-release-notes

Automates updating next.mdx release notes with merged PR entries and archiving versions.

49.7k|3.4k|Updated May 9, 2021
One-click install
npx skills add https://github.com/tldraw/tldraw --skill update-release-notes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-release-notes
Source: https://github.com/tldraw/tldraw/tree/main/.claude/skills/update-release-notes
Command: npx skills add https://github.com/tldraw/tldraw --skill update-release-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, gh, jq, and includes scripts (resource) components.

What problem does it solve?

This Skill automates the maintenance of release notes by updating the release notes file at apps/docs/content/releases/next.mdx with newly merged PR entries and archiving the previous next.mdx to a versioned file when a new release is published.

Core Features & Use Cases

  • Automatic PR incorporation: adds merged PR entries to next.mdx based on the diff against the latest release.
  • Archival workflow: archives next.mdx into vX.Y.0.mdx when a new version is published, updating frontmatter and preserving history.
  • Workflow automation: integrates with the repository's scripts to retrieve PR data, format entries, and reset next.mdx for the next cycle.

Quick Start

Run the status script to determine diffs and last_version, then run the update workflow to populate next.mdx and archive when needed.

Frequently Asked Questions about update-release-notes

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

FAQPage Schema
How do I automate release notes from merged PRs in a monorepo?

To automate release notes from merged PRs, this skill updates the next.mdx file with newly merged PR entries by retrieving PR data through gh and git diffs, formatting the entries as markdown, and appending them to your documentation.

How does release note archival work when publishing a new version?

Release note archival works by renaming the existing next.mdx file to a versioned vX.Y.0.mdx file, updating the frontmatter to preserve history, and resetting next.mdx to start the next release cycle.

Do I need git, gh, and jq installed to automate changelog generation?

Yes, you need git, gh, and jq installed to automate changelog generation because the Bash scripts rely on gh to fetch PR details, git to determine version diffs, and jq to parse the retrieved PR data.

Can I use this automated release notes workflow outside an apps/docs/releases structure?

No, you cannot use this workflow outside an apps/docs/releases structure because the scripts are hardcoded to find and update the release notes file specifically at apps/docs/content/releases/next.mdx.

What is the best way to track merged PRs for changelog updates?

The best way to track merged PRs for changelog updates is running the status script to determine the diff against the latest release, which identifies newly merged entries to fetch and format into the next.mdx file.

Why is my next.mdx release notes file not updating with new PRs?

Your next.mdx release notes file may not update if the status script fails to determine the diff against the latest version, or if gh lacks the required permissions to fetch the merged PR data needed for formatting.