chore: add registry install flow
This commit is contained in:
+28
-14
@@ -9,6 +9,7 @@ The current goal is modest:
|
||||
- keep release notes attached to the changes that caused them
|
||||
- avoid inventing ad hoc version bumps when the component system evolves
|
||||
- make release intent enforceable in CI before package work merges
|
||||
- keep the generated registry metadata aligned with versioned source
|
||||
|
||||
## Current assumptions
|
||||
|
||||
@@ -68,6 +69,7 @@ At minimum, run:
|
||||
|
||||
```bash
|
||||
pnpm lint
|
||||
pnpm registry:check
|
||||
pnpm typecheck
|
||||
pnpm test
|
||||
```
|
||||
@@ -104,10 +106,10 @@ keep the dependency graph coherent without requiring manual package edits.
|
||||
|
||||
### 4. Version the packages
|
||||
|
||||
When it is time to cut a release manually, run the Changesets version step:
|
||||
When it is time to cut a release manually, run the repo version step:
|
||||
|
||||
```bash
|
||||
pnpm changeset version
|
||||
pnpm release:version
|
||||
```
|
||||
|
||||
That step is expected to:
|
||||
@@ -115,6 +117,7 @@ That step is expected to:
|
||||
- update package versions
|
||||
- update internal dependency ranges where needed
|
||||
- consume the pending changeset files
|
||||
- rebuild `registry/index.json` so the copy-in install metadata stays version-aligned
|
||||
|
||||
Review the resulting package diffs carefully before merging.
|
||||
|
||||
@@ -122,17 +125,19 @@ On `main`, the repository also runs a `Release Version PR` workflow that opens o
|
||||
version PR with the same command. That workflow is intentionally limited to version-file updates;
|
||||
it does not publish packages.
|
||||
|
||||
### 5. Publish or tag
|
||||
### 5. Distribute the versioned source
|
||||
|
||||
Publishing is not fully wired in this repo yet, so treat this step as pending infrastructure.
|
||||
Publishing is not fully wired in this repo yet, so the consumable artifact is the versioned
|
||||
repository state itself.
|
||||
|
||||
The intended future flow is:
|
||||
After the version PR merges:
|
||||
|
||||
```bash
|
||||
pnpm changeset publish
|
||||
```
|
||||
- keep the merge commit as a stable install point, or create a maintainer tag for it
|
||||
- treat the committed `registry/index.json` as the install contract for that repo state
|
||||
- point consumers at that commit or tag when they run `pnpm registry:install`
|
||||
|
||||
But until registry, auth, and CI behavior are explicit, do not assume publish is automated.
|
||||
See [docs/registry.md](/Users/xd/project/cadence-ui/docs/registry.md) for the consumer
|
||||
install and upgrade flow.
|
||||
|
||||
## CI workflows
|
||||
|
||||
@@ -153,16 +158,24 @@ pnpm changeset:status --since origin/main
|
||||
|
||||
This validates that pending changesets resolve cleanly against the base branch.
|
||||
|
||||
The workflow also runs:
|
||||
|
||||
```bash
|
||||
pnpm registry:check
|
||||
```
|
||||
|
||||
This prevents registry metadata drift from merging unnoticed.
|
||||
|
||||
### Version PR workflow
|
||||
|
||||
The `Release Version PR` workflow runs on pushes to `main` and on manual dispatch. It:
|
||||
|
||||
- installs dependencies
|
||||
- runs `pnpm changeset version`
|
||||
- runs `pnpm release:version`
|
||||
- opens or updates a version PR using `changesets/action`
|
||||
|
||||
This is a versioning skeleton, not a publish pipeline. It is safe to enable before registry
|
||||
credentials or publish commands exist.
|
||||
This is still a versioning skeleton, not a publish pipeline, but the version PR now refreshes
|
||||
the committed registry metadata that consumers install from.
|
||||
|
||||
## Future publish prerequisites
|
||||
|
||||
@@ -183,5 +196,6 @@ Before turning the version workflow into a publish workflow, the repo still need
|
||||
|
||||
## Main-thread follow-up still needed
|
||||
|
||||
This baseline now covers changeset intent checks in PRs and version PR creation on `main`.
|
||||
What remains is the publish decision and any registry-specific automation.
|
||||
This baseline now covers changeset intent checks in PRs, registry metadata validation, and
|
||||
version PR creation on `main`. What remains is the publish decision, tagging policy, and any
|
||||
registry-specific automation beyond source-copy installs.
|
||||
|
||||
Reference in New Issue
Block a user