sanity-changelog

Creates and publishes Novu changelog entries as Sanity changelogPost documents from Linear releases.

39.7k|4.4k|Updated Aug 26, 2021
One-click install
npx skills add https://github.com/novuhq/novu --skill sanity-changelog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sanity-changelog
Source: https://github.com/novuhq/novu/tree/main/.cursor/skills/sanity-changelog
Command: npx skills add https://github.com/novuhq/novu --skill sanity-changelog

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Writing and publishing consistent changelog entries for the Novu website requires coordinating Sanity CMS documents, Linear release data, and strict Portable Text formatting, which is error-prone when done manually.

Core Features & Use Cases

  • Feature changelog posts: Drafts changelogPost documents in Sanity with resolved author and category references, Portable Text body content, and code blocks.
  • Improvements & fixes roundups: Reviews Linear releases since the last published changelog and rolls customer-relevant changes into changeBlock components.
  • Draft-safe editing: Creates drafts only, patches existing drafts by Portable Text _key, and publishes only when explicitly requested.
  • Use Case: After a release ships, ask for a roundup of improvements and fixes; the Skill queries Linear releases, filters customer-facing items, and creates a formatted draft in the Novu Website Sanity project.

Quick Start

Write a changelog entry in Sanity for the improvements and fixes shipped since the last Novu release.

Frequently Asked Questions about sanity-changelog

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

FAQPage Schema
How do I create a changelog entry in Sanity from Linear releases?

List releases in the Linear cloud-production pipeline after the last changelog-published release, fetch their issues, and filter to customer-relevant fixes and improvements. Then create a draft changelogPost in Sanity with a changeBlock for improvements and fixes.

How do I build a roundup of improvements and bug fixes for a changelog?

Review Linear releases since the last published changelog, exclude dependency bumps, refactors, and CI changes, then group the remaining items by area. Each item uses a bold lead-in label plus one clear sentence inside a changeBlock of type improvements or fixes.

Can the Sanity MCP upload local screenshot images?

No, the Sanity MCP cannot upload local image files. Have the user drop the screenshot into the Cover Image field in Sanity Studio, or upload it via the Sanity assets HTTP API with a write token and reference the asset by _ref.

Why did my Sanity document get published instead of saved as a draft?

Using a raw Sanity client create call without setting _id to drafts.<uuid> creates a published document, even if publishedAt is unset. Use the Sanity MCP create_documents tool, which always writes to drafts.

How do I edit an existing Sanity draft without overwriting other changes?

Use patch_documents with insert operations targeting array items by their Portable Text _key, such as content[_key=="abc123"]. This preserves concurrent edits like uploaded images, author changes, and captions.