82 lines
2.5 KiB
Markdown
82 lines
2.5 KiB
Markdown
# Changesets In This Repo
|
|
|
|
This directory is the release-intent ledger for Cadence UI.
|
|
|
|
Changesets now drives the package-first release flow for:
|
|
|
|
- `@ai-ui/ui`
|
|
- `@ai-ui/tokens`
|
|
|
|
The two packages move as a fixed version pair. Changesets remains the source of truth for:
|
|
|
|
- version intent
|
|
- consumer-facing release notes
|
|
- version PR generation
|
|
- publish coordination for the package pair
|
|
|
|
## CI behavior
|
|
|
|
This repo now has four release-adjacent workflows:
|
|
|
|
- `Changeset Status` runs on pull requests and checks whether changes to releasable packages
|
|
include a `.changeset/*.md` entry, while also verifying both package and registry consumer flows.
|
|
- `Release Version PR` runs on `main` and opens or updates a version PR by running
|
|
`pnpm release:version`.
|
|
- `Create Release Tag` runs on `main` after the version pair changes and creates `cadence-ui-vX.Y.Z`.
|
|
- `Publish Packages` runs on `cadence-ui-v*` tags and publishes the package pair.
|
|
|
|
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:
|
|
|
|
```md
|
|
Add the Sheet component for contextual side panels and bottom trays.
|
|
```
|
|
|
|
Less useful:
|
|
|
|
```md
|
|
Refactor dialog wrapper internals and update story coverage.
|
|
```
|
|
|
|
## Current release posture
|
|
|
|
The root repo remains private, but `@ai-ui/ui` and `@ai-ui/tokens` are now treated as published
|
|
packages. The automated flow is:
|
|
|
|
1. merge a changeset-backed package change
|
|
2. merge the version PR generated on `main`
|
|
3. let the tag and publish workflows ship the fixed package pair
|
|
|
|
See [docs/releasing.md](/Users/xd/project/cadence-ui/docs/releasing.md) for the current release
|
|
workflow and [docs/registry.md](/Users/xd/project/cadence-ui/docs/registry.md) for the optional
|
|
source-copy mode.
|