You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Release-Readiness.md
+52-26Lines changed: 52 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
Intent is in early experimental development. No packages have been published to npm. No GitHub Releases have been created.
6
6
7
-
The repository has five workspace packages under `packages/*`. The four publishable packages are at version `0.1.0-alpha.0`. The private server package remains at `0.1.0`. All use `workspace:*` dependency references. The codebase is functional and validated by CI. Changesets is installed and configured. The remaining blocker before a first alpha release is the release workflow and npm publish automation.
7
+
The repository has five workspace packages under `packages/*`. The four publishable packages are at version `0.1.0-alpha.0`. The private server package remains at `0.1.0`. All use `workspace:*` dependency references. The codebase is functional and validated by CI. Changesets is installed and configured. Release workflows exist for automated version PRs and manual alpha publishing.
8
8
9
9
Four packages are intended for first-alpha publishing. `packages/server` is a private workspace package for now.
10
10
@@ -179,23 +179,28 @@ The `files` field in every package is `["dist"]`. Based on `npm pack --dry-run`
179
179
180
180
No unnecessary files (source maps, config files, tests, node_modules) leak into the tarball. The `files` policy is correct.
181
181
182
-
## Release workflow recommendation
182
+
## Release workflows
183
183
184
-
### Use Changesets
184
+
### Version Packages PR workflow
185
185
186
-
[Changesets](https://github.com/changesets/changesets) is recommended for:
186
+
A Changesets-based [version-packages.yml](../.github/workflows/version-packages.yml) workflow runs on pushes to `main`:
187
187
188
-
- Version bumping (independent versioning per package)
189
-
- Changelog generation per package
190
-
- Coordinated publishing across the workspace
188
+
1. Checks out the repository
189
+
2. Installs dependencies
190
+
3. Runs `pnpm version:packages` via `changesets/action`
191
+
4. Opens or updates a "Version Packages" PR when changeset files are present
191
192
192
-
### Recommended GitHub Action
193
+
This workflow does **not** publish to npm. It only manages the version PR.
193
194
194
-
Add a Changeset-based GitHub Action (e.g., `changesets/action`) that:
195
+
### Manual Publish Alpha workflow
195
196
196
-
1. Runs on pushes to `main`
197
-
2. Opens or updates a "Version Packages" PR when changeset files are present
198
-
3. Publishes to npm when the version PR is merged
197
+
A [publish-alpha.yml](../.github/workflows/publish-alpha.yml) workflow exists for publishing:
198
+
199
+
-**Trigger**: manual only (`workflow_dispatch`)
200
+
-**Environment**: requires the `npm` GitHub environment
0 commit comments