cadence-ui/.changeset/README.md

Changesets In This Repo

This directory is the release-intent ledger for Cadence UI.

The repo is still an internal/private monorepo, so Changesets is used conservatively:

• track version intent for releasable workspace packages
• keep release notes attached to code changes
• avoid tagging private packages during early internal iteration
• let CI verify release intent before package work merges

CI behavior

This repo now has two release-adjacent workflows:

• Changeset Status runs on pull requests and checks whether changes to releasable packages include a .changeset/*.md entry, while also verifying that registry/index.json is current.
• Release Version PR runs on main and opens or updates a version PR by running pnpm release:version.

The PR check intentionally focuses on the releasable packages in scope today:

• @ai-ui/ui
• @ai-ui/tokens

If a PR touches those packages but should not create a release note, apply the no-changeset-needed label. This is the escape hatch for work such as:

• docs-only follow-up near a package
• test-only changes
• internal refactors with no consumer-visible behavior change

What should get a changeset

Create a changeset when a change affects:

• @ai-ui/ui
• @ai-ui/tokens

Do not create a changeset for docs-only work in @ai-ui/docs unless that work ships alongside a package change that already needs one. The docs app is ignored in the config on purpose.

What kind of summary to write

Keep the summary short and consumer-facing:

• describe what changed
• mention the component, token, or contract surface
• avoid implementation detail unless it changes behavior

Good:

Add the Sheet component for contextual side panels and bottom trays.

Less useful:

Refactor dialog wrapper internals and update story coverage.

Current release posture

The root repo is private and package publishing is not fully wired yet. Until the main release flow is enabled, treat Changesets as the source of truth for:

• which package versions should move
• which changes deserve release notes
• which internal dependency bumps should be coordinated

The current automation stops at version intent, registry metadata refresh, and version PR creation. It does not publish to npm, create tags, or assume any package registry credentials exist yet.

See docs/releasing.md for the expected workflow around creating and consuming changesets.