changeset

Create Changesets entries documenting release notes and versioning for dle.dev.

Updated Dec 13, 2019
One-click install
npx skills add https://github.com/polaroidkidd/dle.dev --skill changeset-polaroidkidd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changeset
Source: https://github.com/polaroidkidd/dle.dev/tree/main/.agents/skills/changeset
Command: npx skills add https://github.com/polaroidkidd/dle.dev --skill changeset-polaroidkidd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Draft and create Changesets entries to document release notes and versioning, enabling consistent, machine-checkable release documentation across PRs and CI checks.

Core Features & Use Cases

  • Uses @changesets/cli to manage changeset files stored in .changeset/.
  • Encourages documenting release-visible changes for the dle.dev package and downstream consumers.
  • Provides examples and guidance for when to create and how to format changesets for PRs.

Quick Start

Create a changeset entry in the .changeset/ directory describing the release impact.

Frequently Asked Questions about changeset

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

FAQPage Schema
How do I create changeset entries for release notes in pull requests?

Changesets document release notes and versioning by generating markdown files in the .changeset/ directory. They provide machine-checkable release documentation that CI workflows validate, ensuring all pull requests include visible version impact statements for downstream consumers.

How do I automate changeset validation in CI workflows?

Changesets integrate with CI workflows by checking for .changeset/*.md files during pull request validation. The @changesets/cli validates that each PR includes a properly formatted entry with the 'dle.dev' package key, blocking merges when documentation is missing.

What is the correct format for changeset files using the @changesets/cli workflow?

Changeset files follow a markdown format with YAML frontmatter specifying the 'dle.dev' package key and version bump level. The file body contains a human-readable summary of release notes, stored in the .changeset/ directory for @changesets/cli processing.

Do I need @changesets/cli installed to manage release notes for dle.dev?

The @changesets/cli package is required to validate and process changeset files. It reads .changeset/*.md entries, checks the 'dle.dev' package key in frontmatter, and generates release notes, making it essential for CI integration and pull request workflows.

Why should I use changesets instead of manually editing release notes?

Changesets enforce consistent, machine-checkable release documentation across pull requests. By storing entries in .changeset/*.md with the 'dle.dev' package key, CI can validate that every PR documents its release impact, preventing undocumented changes from reaching production.

When do I need to add a changeset entry to my pull request?

A changeset entry is needed whenever a pull request introduces release-visible changes to the dle.dev package. Create a .changeset/*.md file documenting the version bump and release notes summary so CI validation passes and downstream consumers receive accurate update information.