cloudflare/kumo
Publicmirrored fromhttps://github.com/cloudflare/kumoAvailable
.changeset/README.md
39lines · modecode
| 1 | # Changesets |
| 2 | |
| 3 | This repo uses [Changesets](https://github.com/changesets/changesets) to manage versioning and changelog entries. |
| 4 | |
| 5 | ## When is a changeset required? |
| 6 | |
| 7 | | Package | Changeset Required? | Why | |
| 8 | | --------------------------- | ------------------------------------------ | ----------------------------------------------------- | |
| 9 | | `packages/kumo/` | **Yes** (enforced by pre-push) | Published to npm as `@cloudflare/kumo` | |
| 10 | | `packages/kumo-docs-astro/` | Optional (version used for `/api/version`) | Not published, but version exposed in docs site build | |
| 11 | | `packages/kumo-figma/` | No | Figma plugin, not published to npm | |
| 12 | |
| 13 | The pre-push hook (`lefthook.yml`) **only enforces** changesets for `packages/kumo/` changes. |
| 14 | |
| 15 | ### How `pnpm changeset version` works |
| 16 | |
| 17 | When you run `pnpm changeset version`, it processes **all packages** in the monorepo (not just kumo), so: |
| 18 | |
| 19 | - It will bump `kumo-docs-astro` version if included in a changeset |
| 20 | - The docs version appears at `/api/version` as `docsVersion` (for debugging deployed builds) |
| 21 | - No automated tooling depends on the docs version number being "correct" |
| 22 | |
| 23 | ## Creating a changeset |
| 24 | |
| 25 | ```bash |
| 26 | pnpm changeset |
| 27 | ``` |
| 28 | |
| 29 | Then: |
| 30 | |
| 31 | - Select the package(s) you changed |
| 32 | - Choose the appropriate bump type (patch/minor/major) |
| 33 | - Write a short description of why the change matters |
| 34 | |
| 35 | Commit the generated `.md` file in this folder. |
| 36 | |
| 37 | ## Why this file exists |
| 38 | |
| 39 | If `.changeset/config.json` is missing, `pnpm changeset` fails with an `ENOENT` error. Keeping the config committed prevents that. |
| 40 | |